Робота з документами
Всі запити нижче перерахованих API методів платформи EDIN 2.0 направляються на адресу: https://edo-v2.edin.ua
Для роботи з цими методами користувач повинен бути авторизованим.
Створення чернетки документа / Клонування відправленого документа (COMDOC)
POST /api/v2/eds/doc
За допомогою цього методу можливо створити чернетку документа (передається тіло документа) зазначеного типу (параметр doc_type) для вказаного одержувача АБО можливо клонувати відправлений документ (передається параметр clone_from_doc_uuid) в чернетку.
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/v2/eds/doc?gln=9864065702429&doc_type=orders |
|
URL параметри |
gln (обов’язково) рядок (13) - номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта doc_type (обов’язково/-) рядок - тип створюваного документа (опис параметру); даний параметр не передається при клонуванні документа (коли передається clone_from_doc_uuid параметр); clone_from_doc_uuid (обов’язково/-) рядок - унікальний ідентифікатор вже відправленого документа (COMDOC) для клонування в чернетку (при цьому тіло передавати не обов’язково, а Content-Type=application/json); даний параметр не передається при створенні чернетки документа |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
|
|
REQUEST |
|
|
JSON Body |
При створенні чернетки в тілі запиту методу передається документ у форматі JSON або XML або P7S в бінарному вигляді (приклад запиту (в тому числі й для створення CONDRA та TRANSPORTATIONORDER) + специфікації документів) |
RESPONSE
В тілі відповіді передаються дані створеного документа (об’єкт XDoc ).
Відправка чернетки
PATCH /api/eds/doc/send
За допомогою цього методу можлива відправка чернетки (з додатковими особливостями відправки).
Наявність ритейлера при документообігу автоматично визначається платформою (тобто якщо Відправник або Одержувач є ритейлером, то створений ланцюжок буде мати позначку конкретного ритейлера).
REQUEST
|
URL |
|
|
Метод запиту |
PATCH |
|
URL запиту |
/api/eds/doc/send?gln=9864065702429&doc_uuid=8c8a70e7-81c6-4382-8b58-7d60c3bc6ffd |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; АБО guid (обов’язково) String - унікальний ідентифікатор власної Компанії; doc_uuid (обов’язково) String - унікальний ідентифікатор документа; doc_hash (опціонально) - рядок; хеш документа; chain_hash (опціонально) - рядок; хеш ланцюжка документів; chain_uuid (опціонально) - рядок; ID ланцюжка документів; partner_id (опціонально) - число; id торгової мережі (можливо отримати з довідника торгових мереж); chain_type (опціонально) - число; тип ланцюжка документів;
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу опціонально передаються додаткові поля Виняток: при відправці
в тілі запиту обов’язково передається параметр sub_status_id. |
Приклад для відправки «Заявки на транспортування» / «Підтвердження транспортування» (TRANSPORTATIONORDER):
{"extra_fields":{"sub_status_id":"1"}}
RESPONSE
Код сервера 200 (ok).
Відправка документа (без створення чернетки)
POST /api/eds/doc/create_and_send
Метод є універсальним для різних типів документів і дозволяє одночасно створити та відправити документ без створення чернетки.
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/eds/doc/create_and_send?doc_type=orders&gln=9864065702429 |
|
URL параметри |
gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта doc_type - рядок; тип документа (опис параметру) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
|
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передєються тільки один файл-вкладення в форматі |
При вказуванні application/pkcs7-signature доступна можливість обробки BASE64 формату.
RESPONSE
-
chain_uuid - ідентифікатор ланцюжка, в якому знаходиться документ
-
doc_uuid - ідентифікатор документа на платформі EDIN 2.0;
-
ticket_uuid - ідентифікатор квитанції
Параметр ticket_uuid система повертає тільки у випадках, коли на існуючий документ намагаються створити додатковий тікет (підписання у відповідь, відмова від підпису, запит на анулювання). Тобто, якщо документ новий, система поверне у відповідь тільки chain_uuid та doc_uuid.
Приклад відповіді (JSON):
{
"chain_uuid": "7ccff78e-ea42-47ea-81e4-5508ed4fbd51",
"doc_uuid": "3698b501-e1ef-464d-a71a-58066f556114",
"ticket_uuid": "1003706c-3656-497b-9438-c6f33e27c36d"
}
Пошук документів (з фільтрацією), вибір списку документів
За допомогою цього методу можна швидко зробити пошук по заданим критеріям, наприклад, отримати список документів з певним статусом або за проміжок часу.
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/eds/docs/search?gln=9864065702429&status_id=2 |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі status_id (опціонально) int - id папки документів:
family (опціонально) String - назва сімейства документів:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передаються обов’язкові та додаткові критерії пошуку/фільтрації |
RESPONSE
В тілі відповіді передається масив документів.