Порядок дій користувача JDOC
Чіткий сценарій: кабінет, баланс, API-ключ, webhook за потреби, відправка документів і отримання JSON.
Відкрити кабінетAPI документаціяПорядок дій
- Увійдіть у кабінет JDOC. Перевірте компанію, роль і доступний баланс документів.
- Поповніть баланс. У кабінеті відкрийте розділ Тарифи й оплата та оберіть пакет.
- Створіть API-ключ. У розділі API ключі створіть ключ компанії. Повний ключ показується тільки один раз, тому одразу збережіть його.
- Відкрийте приклади запитів. Під API-ключем натисніть Приклади API або відкрийте API документацію.
- Налаштуйте webhook, якщо потрібна автоматична доставка. У розділі Webhook вкажіть URL вашої системи. Якщо webhook не потрібен — пропустіть цей крок.
- Надішліть документ. Через API можна відправити PDF, PNG, JPG/JPEG або TIFF. Можна надіслати 1 файл або пакет до 100 файлів за один запит.
- Збережіть
operation_id. Його повертає відповідь на завантаження. За ним перевіряється статус і забирається результат. - Перевіряйте статус. Використовуйте
GET /api/v1/operations/{operation_id}або відкрийте розділ Операції в кабінеті. - Отримайте JSON. Коли статус стане
PROCESSEDабоPROCESSED_WITH_WARNINGS, результат буде вdocuments[].result. - Передайте JSON у свою систему. Для 1С/BAS використовуйте розділ Інтеграція з 1С/BAS.
Життєвий цикл операції
| Статус | Що означає | Дія користувача |
|---|---|---|
ACCEPTED | JDOC прийняв запит і створив операцію. | Збережіть operation_id. |
QUEUED | Документ очікує своєї черги. | Перевірте статус через кілька секунд. |
PROCESSING | Документ обробляється. | Очікуйте завершення або webhook. |
PROCESSED | JSON готовий без попереджень. | Заберіть documents[].result. |
PROCESSED_WITH_WARNINGS | JSON готовий, але є попередження. | Перевірте warnings перед імпортом. |
FAILED | Документ не вдалося обробити. | Подивіться помилку, виправте файл або запит і повторіть. |
Корисні розділи
API документація
Запити для відправки 1 або до 100 документів, отримання операцій, документів і результатів.
Відкрити