Все руководства

Команда и администрирование

API-эндпоинты

Программы, скрипты и автоматизации отправляют документы на секретный URL и печатают их.

API-эндпоинт — это секретный URL, на который программы отправляют документы, например счета из ERP-системы, этикетки из интернет-магазина или отчёты из скрипта. Каждый документ становится заданием от имени человека, который создал эндпоинт, и попадает в маршрут эндпоинта. Сам URL является ключом доступа, поэтому токен API не нужен. Справочник API описывает все параметры.

Предварительные условия

  • Входящий канал REST API должен быть включён в разделе Настройки → Входящие каналы. В новых организациях он включён; в более старых его, возможно, должен включить администратор.
  • Любой участник может создавать API-эндпоинты. Пользователи видят свои, администраторы — все эндпоинты организации.
  • Входит в каждый тариф.

Однократная настройка

  1. Перейдите в Источники → Конечные точки API и выберите Новый API-эндпоинт.
  2. Введите Название, которое говорит, для чего используется эндпоинт, например «Счета ERP».
  3. Выберите Маршрут для документов, в запросе которых маршрут не указан: назначение, группу или рабочий процесс, Маршрут по умолчанию или Без маршрута – хранить в Sealed Print.
  4. Выберите Создать и скопируйте URL эндпоинта в свою программу.

Отправьте документ телом запроса с подходящим Content-Type:

curl -X POST "https://www.sealedprint.com/api/print/sp_ep_…?name=Invoice" \
  -H "Content-Type: application/pdf" \
  --data-binary @invoice.pdf

Или формой с полем file; параметры передаются как поля формы:

curl -X POST "https://www.sealedprint.com/api/print/sp_ep_…" \
  -F "file=@invoice.pdf" \
  -F "name=Invoice" \
  -F "copies=2"

targets отправляет один запрос в другое место по идентификатору: идентификаторы назначений, групп или рабочего процесса через запятую, например targets=office,warehouse (рабочий процесс указывается первым). destinationId, destinationIds, groupId или workflowId делают то же самое по ID, а noTarget=true (или targets=hold) оставляет документ в Sealed Print. Они переопределяют маршрут эндпоинта для одного запроса; параметры печати, например copies или sides, передаются как параметры запроса или поля формы. Ответом является задание (HTTP 201).

Каждый раз

  • Последнее использование у эндпоинта показывает, отправляет ли программа ещё документы.
  • Изменить меняет название и маршрут; URL остаётся прежним.
  • Создать новый URL заменяет URL; старый сразу перестаёт работать. Удалить окончательно удаляет эндпоинт.
  • Чтобы отслеживать статус задания из программы, используйте токен API.

Устранение неполадок

  • HTTP 403: входящий канал REST API выключен, или человек, создавший эндпоинт, покинул организацию. Создайте новый эндпоинт от имени другого участника.
  • HTTP 404: URL неверен или был заменён новым. С кодом unknown_target идентификатор в targets не существует или принадлежит назначению, в которое владелец эндпоинта не может печатать.
  • HTTP 413 или 415: файл больше, чем допускает тариф, или не является PDF, JPEG или PNG.
  • URL попал туда, где его быть не должно: сразу выберите Создать новый URL.

Что дальше