Опис методів IDP сервісу
Дана інструкція описує послідовність викликів методів API, призначених для розпізнавання та перетворення PDF-файлів у структуровані документи.
Для роботи з методами сервісу EDIN-IDP у вас має бути IDP_API_KEY, який потрібно вказувати в Header в параметрі x-api-key
Відправка документа на розпізнання
Під час одного запиту можна надіслати лише один файл.
REQUEST
| URL | https://idp.edin.ua/api/docs/upload |
| Method | POST |
| Header | x-api-key={IDP_API_KEY} |
| Content-Type: multipart/form-data |
Опціонально: у параметрах запиту користувач може вказати from_user — логін користувача свого акаунту, від імені якого буде здійснено відправку.
Приклад запиту:
curl -v -H "x-api-key: {IDP_API_KEY}" -F upload='@{path to file}' https://idp.edin.ua/api/docs/uploadRESPONSE
-
У відповідь надходить унікальний ідентифікатор (UUID) завдання на конвертацію.
Отримання списку файлів
REQUEST
| URL | https://idp.edin.ua/api/docs/search |
| Method | POST |
| Header | x-api-key={IDP_API_KEY} |
| Body | Content-Type: application/json |
У тілі запиту необхідно передати JSON об'єкт IDPTasksQuery.
Опціонально: у параметрах запиту користувач може вказати from_user — логін користувача свого акаунту, від імені якого буде здійснено фільтрацію документів.
Приклад запиту:
curl -v -X POST -H "x-api-key: MY_TEST_API_KEY" -H "Content-Type: application/json" --data '{"status": ["DONE", "VERIFIED"]}' https://idp.edin.ua/api/docs/searchRESPONSE
- Масив об'єктів
IDPTask[].
Приклад відповіді:
[
{
"id": 293,
"userId": 2000988,
"uuid": "90c5f7ae-5747-4f56-bf07-068bfe8160cf",
"status": "DONE",
"date": 1753077616,
"doneDate": 1753077643,
"info": {
"source": "API",
"mimeType": "image/jpeg",
"fileName": "300625_111323_1493.jpg"
}
}
]Отримання результату конвертації файлу
REQUEST
| URL | https://idp.edin.ua/api/docs/response?uuid={uuid завдання} |
| Method | GET |
| Header | x-api-key={IDP_API_KEY} |
Приклад запиту:
curl -v -H "x-api-key: {IDP_API_KEY}" 'https://idp.edin.ua/api/docs/response?uuid=90c5f7ae-5747-4f56-bf07-068bfe8160cf'RESPONSE
- У відповідь надходить json-масив структурованих документів. Структура документів може бути або типовою (універсальною), або згідно з індивідуальними налаштуваннями
Отримання вмісту файлу, відправленого на конвертацію
REQUEST
| URL | https://idp.edin.ua/api/docs/request?uuid={uuid завдання} |
| Method | GET |
| Header | x-api-key={IDP_API_KEY} |
Приклад запиту:
curl -v -H "x-api-key: {IDP_API_KEY}" 'https://idp.edin.ua/api/docs/request?uuid=90c5f7ae-5747-4f56-bf07-068bfe8160cf'- У відповідь надходить унікальний ідентифікатор (UUID) завдання на конвертацію.
RESPONSE
- У відповідь надходить оригінальний файл, який було відправлено на розпізнавання та перетворення.
Зміна статусу завдання
REQUEST
| URL | https://idp.edin.ua/api/docs/status?uuid={uuid завдання}&status=[CREATED|VERIFIED|PROCESSED] |
| Method | POST |
| Header | x-api-key={IDP_API_KEY} |
Приклад запиту:
curl -v -H "x-api-key: {IDP_API_KEY}" 'https://idp.edin.ua/api/docs/status?uuid=90c5f7ae-5747-4f56-bf07-068bfe8160cf&status=PROCESSED'RESPONSE
У відповіді повертається повідомлення та статус:
| STATUS | Message | Коментар |
| 200 | Запит успішно опрацьовано | Статус задачі змінено успішно |
| 400 | Unsupported 'status' param value | Неправильний статус завдання. Вкажіть коректний статус |
| 400 | Only task with status DONE can be changed to VERIFIED. Current task status is: PROCESSED | Неправильна послідовність зміни статусу |
| 500 | Internal Server Error. Chanel ID: 123456 | Непередбачена внутрішня помилка. Необхідно звернутись до тех. підтримки для зʼясування причини помилки. |