Команда та адміністрування
Кінцеві точки API
Дозвольте програмам, скриптам та автоматизаціям надсилати документи на секретну URL-адресу й друкувати їх.
Кінцева точка API – це секретна URL-адреса, на яку програми надсилають документи, наприклад рахунки з ERP-системи, етикетки з інтернет-магазину або звіти зі скрипта. Кожен документ стає завданням від імені людини, яка створила кінцеву точку, і надходить до цілі цієї кінцевої точки. Сама URL-адреса є ключем доступу, тож токен API не потрібен. Довідник API описує всі параметри.
Передумови
- Вхідний канал REST API має бути ввімкнено в розділі Налаштування → Вхідні канали. У нових організаціях його ввімкнено; у старіших його, можливо, має ввімкнути адміністратор.
- Кожен учасник може створювати кінцеві точки API. Користувачі бачать свої, адміністратори – усі кінцеві точки організації.
- Входить у кожен тариф.
Одноразове налаштування
- Перейдіть до Джерела → Кінцеві точки API і виберіть Новий API-ендпоінт.
- Введіть Назва, яка пояснює, для чого використовується кінцева точка, наприклад «Рахунки ERP».
- Виберіть Ціль для документів, у запиті яких ціль не вказано: призначення, групу або робочий процес, Ціль за замовчуванням або Без цілі – зберігати в Sealed Print.
- Виберіть Створити і скопіюйте 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-адресу.
Що далі
- Довідник API: усі кінцеві точки з описом OpenAPI.
- Токени API
- Вхідні та вихідні канали
- Друк документів Stripe: рахунки, кредитові ноти та пропозиції зі Stripe через кінцеву точку API.