Перелік методів API сервісу EDI Network
Всі запити нижче перерахованих API методів платформи EDIN 2.0 направляються на адресу: https://edo-v2.edin.ua
Для роботи з цими методами користувач повинен бути авторизованим.
Робота з документами
|
Створити чернетку документа / Клонувати відправлений документ (COMDOC) |
POST /api/v2/eds/doc |
|
Відправити чернетку |
PATCH /api/eds/doc/send |
|
Відправити документ (без створення чернетки) |
POST /api/eds/doc/create_and_send |
|
Пошук документів (з фільтрацією), вибір списку документів |
POST /api/eds/docs/search |
|
Отримати інформацію (мета-дані) про документ |
GET /api/eds/doc |
|
Отримати конкретний ланцюжок документів |
GET /api/eds/chain |
|
Отримати ланцюжки вхідних документів |
POST /api/eds/chains/search |
|
Отримати контент документа |
GET /api/eds/doc/body |
|
Отримати XML контенту документа |
GET /api/eds/doc/xml |
|
Завантажити тіло документа/підпису |
GET /api/eds/doc/download |
|
Відправити статус документа |
POST /api/eds/doc/statuses |
|
Отримати статус документа |
GET /api/eds/doc/statuses |
|
Редагувати чернетку документа |
PUT /api/eds/doc |
|
Заповнити індекси (додавання / оновлення полів екстрапараметрів) |
PUT /api/eds/doc/extra_fields |
|
Архівувати / Розархівувати ланцюжок документів |
PATCH /api/eds/chain/archive |
|
Отримати реєстр документів в xls форматі |
GET /api/eds/doc/reports/doctype |
|
Отримати інформацію про підпис/підписантів |
GET /api/eds/doc/attachment/sign/info |
|
Видалити документи-чернетки |
PATCH /api/eds/docs |
|
Отримати тіло документів (json) за вказаними UUID |
POST /api/v2/eds/doc/content |
|
Відправити транзакції до «Резерву товару» PRDRSRVN (зміни в табличній частині) |
POST /api/eds/doc/prdrsrvn/transaction |
|
Одночасне прийняття, підписання та відправка двох пов’язаних документів |
POST /api/eds/docs_and_tickets |
|
Отримати статус документа |
POST /api/v2/eds/docs/state |
Робота з "Універсальним/неструктурованим документом" (CONDRA)
|
Завантажити «Неструктурований (універсальний) документ» (CONDRA) у вигляді архіву |
GET /api/eds/doc/condra/body |
|
Відправити «Неструктурований (універсальний) документ» (CONDRA) |
PATCH /api/eds/doc/condra/send |
|
Створити чернетку «Універсального/неструктурованого документа» (CONDRA) |
POST /api/v2/eds/doc/condra/create |
|
Створити і відправити «Універсальний/неструктурований документ» (CONDRA) без створення чернетки |
POST /api/v2/eds/doc/condra/create_and_send |
|
Додати файл-вкладення (для CONDRA) |
POST /api/eds/doc/body |
|
Створити чернетку документа (для CONDRA) |
POST /api/eds/doc |
|
Отримати UUID (для CONDRA) |
GET /api/office/uuid |
|
Підписати файл (для CONDRA) |
POST /api/eds/doc/body |
|
Відхилити «Універсальний/неструктурований документ» (CONDRA). Створення квитанції №13 |
PATCH /api/v2/eds/condra/reject |
|
Відкликати «Універсальний/неструктурований документ» (CONDRA). Створення квитанції №14 |
PATCH /api/v2/eds/condra/withdraw |
|
Прийняти «Універсальний/неструктурований документ» (CONDRA) |
PATCH /api/v2/eds/condra/confirm/send |
Робота з файлами (вкладення до документа)
|
Додати файл до документа-чернетки |
POST /api/eds/doc/attachment |
|
Отримати файл-вкладення |
GET /api/eds/doc/attachment |
|
Видалити файл-вкладення (чернетка) |
DELETE /api/eds/doc/attachment |
|
Роздрукувати вкладення документа |
GET /api/eds/doc/print |
|
Додати підпис до вкладень документа-чернетки |
POST /api/eds/doc/attachment/sign |
|
Отримати хеш вкладення (контейнера) документа для підписання |
GET /api/eds/doc/attachment/sign/hash |
Робота з квитанціями
|
Отримати всі квитанції вказаного документа |
GET /api/eds/doc/tickets |
|
Отримати інформацію про підписантів |
GET /api/eds/doc/signers |
|
Отримати інформацію про підписантів за всіма вказаними транзакціями документа |
GET /api/v2/eds/doc/signers |
|
Отримати дані/контент квитанції |
GET /api/eds/doc/ticket/body |
|
Створити на сервері квитанцію «Анулювання» |
GET /api/v2/eds/doc/repeal |
|
Створити на сервері квитанцію «Повідомлення про відмову від підписання документу» (COMDOC_021) для COMDOC/TRANSPORTATIONORDER документів |
GET /api/v2/eds/comdoc/reject |
|
Створити на сервері квитанцію «Повідомлення про відмову від підписання документу» (COMDOC_021) |
GET /api/v2/eds/doc/reject |
|
Створити квитанцію №1 (підпис чернетки) |
POST /api/v2/eds/doc/ticket |
|
Створити квитанцію №2 (прийняття документа COMDOC) |
POST /api/v2/eds/comdoc/accept |
|
Створити квитанцію №11 (запит на анулювання COMDOC/DOCUMENTINVOICE/TRANSPORTATIONORDER) |
POST /api/v2/eds/doc/repeal |
|
Створити квитанцію №12 (прийняття запиту на анулювання COMDOC/DOCUMENTINVOICE/TRANSPORTATIONORDER) |
POST /api/v2/eds/doc/repeal/accept |
|
Створити квитанцію №13 (відхилення документа COMDOC/TRANSPORTATIONORDER) |
POST /api/v2/eds/comdoc/reject |
|
Створити квитанцію №14 (відкликати підписання документа COMDOC/TRANSPORTATIONORDER) |
POST /api/v2/eds/comdoc/revoke |
|
Створити квитанцію №15 (відмова від анулювання COMDOC/DOCUMENTINVOICE/TRANSPORTATIONORDER) |
POST /api/v2/eds/doc/repeal/reject |
|
Відправити відмову від підписання (створення квитанції №13) |
POST /api/v2/eds/doc/reject |
|
Створити на сервері квитанцію «Відкликання підписання документа» (COMDOC_021) |
GET /api/v2/eds/doc/revoke |
|
Створити квитанцію №14 (відкликати підписання документа COMDOC/TRANSPORTATIONORDER) |
POST /api/v2/eds/doc/revoke |
Робота з тегами
|
Створити новий тег (мітку) |
POST /api/eds/tags |
|
Отримати список тегів (міток) |
GET /api/eds/tags |
|
Редагувати тег |
PUT /api/eds/tags |
|
Видалити теги |
DELETE /api/eds/tags |
|
Прив'язати тег до документа |
POST /api/eds/doc/tags |
|
Вилучити теги з документа |
DELETE /api/eds/doc/tags |
Погодження
|
Створити сценарій погодження документів |
POST /api/eds/doc/approval/scenario |
|
Отримати сценарій/-ії (на рівні GLN) |
GET /api/eds/doc/approval/scenario |
|
Редагувати / видалити сценарій погодження документів |
PUT /api/eds/doc/approval/scenario |
|
Запуск документа на погодження / Зміна статуса кроку погодження |
POST /api/eds/doc/approval/step |
|
Отримати кроки погодження за документом |
GET /api/eds/doc/approval/step |
Робота з подіями
- Обираєте ідентифікатор документу, з якого Ви плануєте розпочати отримувати всі наступні події.
- Надсилаєте запит на отримання останнього ідентифікатора події за документом.
- В отриманному у відповідь об'єкті XEvent зберігаєте значення параметра id.
- Надсилаєте запит для пошуку подій. В об'єкті запиту EventsStorageQuery, в параметрі fromId вказуєте ідентифікатор події, який Ви отримали в пункті 3.
- З отриманного у відповідь об'єкта EventsStorageQueryResult зберігаєте значення параметра lastEventId замість того, що зберегли в пункті 3.
- Опрацьовуєте документи в EventsStorageQueryResult.
- Якщо кількість значень в параметрі items об'єкта EventsStorageQueryResult:
-
- дорівнює вказаному ліміту (limit) або рівне 100, то повторюйте операції з 4 по 7.
- меньше вказаного ліміту (limit) або менше 100, то необхідно зробити паузу (1 хвилина) для подальшого виконання операцій з 4 по 7.
|
Отримати останню подію за документом
|
GET /api/eds/docs/event/last |
|
Отримати список подій
|
GET /api/eds/docs/events |
|
Пошук подій
|
POST /api/eds/docs/events |