API v2

Алгоритми обміну документами (API)

• Алгоритм «Прайс-лист» (PRICAT)
• Алгоритм «Замовлення» (ORDER)
• Алгоритм «Підтвердження замовлення» (ORDRSP)
• Алгоритм «Повідомлення про відвантаження» (DESADV)
• Алгоритм «Повідомлення про прийом» (RECADV)
• Алгоритм «Видаткова накладна» (COMDOC_006)
• Алгоритм «Акт про виявлені недоліки» (COMDOC_005)
• Алгоритм «Коригування видаткової накладної» (COMDOC_038)

---

Підказка

Всі запити нижче перерахованих API методів платформи EDIN 2.0 направляються на адресу: https://edo-v2.edin.ua

Авторизація

Метод	URL запиту	Опис
POST	/api/authorization/hash	Авторизація
GET	/api/auth_check	Перевірка активності сесії

Робота з довідниками

Метод	URL запиту	Опис
GET	/api/oas/user	Отримання інформації по авторизованому користувачу
GET	/api/oas/account/users	Отримання інформації про всіх користувачів компанії (на рівні акаунта)
GET	/api/oas/account/identifiers	Отримання інформації по GLN номерами, пов’язаним з авторизованим користувачем (на рівні акаунта)
GET	/api/oas/retailers	Отримання переліку роздрібних мереж, які пов’язані із заданим GLN
GET	/api/oas/retailer/identificators	Отримання переліку GLN номерів, які пов’язані із заданою роздрібною мережею
GET	/api/oas/allretailers	Отримання переліку всіх мереж
GET	/api/oas/units	Отримання переліку доступних одиниць виміру
GET	/api/oas/identifiers	Отримання інформації про організацію по Назві/ІПН/КПП/GLN

Робота з об’єднаним віртуальним довідником (всі сервіси в рамках акаунта/користувача)

Метод	URL запиту	Опис
GET	/api/uds/dictionary	Отримати значення з віртуального довідника
POST	/api/uds/dictionary	Створити новий довідник
PUT	/api/uds/dictionary	Оновити довідник
DELETE	/api/uds/dictionary	Видалити довідник
POST	/api/uds/dictionary/values	Додати значення в довідник
DELETE	/api/uds/dictionary/values	Видалити значення з довідника

Робота з документами

Метод	URL запиту	Опис
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	Отримання конкретного ланцюжка документів
GET	/api/eds/doc/body	Отримання контента документа
GET	/api/eds/doc/xml	Отримання XML контента документа
GET	/api/eds/doc/download	Завантажити тіло документа/підпису
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/statuses	Відправка статусу документа
GET	/api/eds/doc/statuses	Отримання статусу документа
POST	/api/eds/doc/body	Додавання файла-вкладення (для CONDRA)
POST	/api/eds/doc	Створення чернетки документа (для CONDRA та TRANSPORTATIONORDER)
PUT	/api/eds/doc	Редагування чернетки документа
GET	/api/office/uuid	Отримання UUID (для CONDRA)
POST	/api/eds/doc/body	Підписання файла (для CONDRA)
PUT	/api/eds/doc/extra_fields	Заповнення індексів (додавання / оновлення полей екстрапараметрів)
PATCH	/api/eds/chain/archive	Архівування / Розархівування ланцюжка документів
GET	/api/eds/doc/reports/doctype	Отримати реєстр документів в xls форматі
GET	/api/eds/doc/print	Роздрукувати вкладення документа
POST	/api/eds/doc/attachment/sign	Додавання підпису до вкладень документа-чернетки
GET	/api/eds/doc/attachment/sign/hash	Отримати хеш вкладення (контейнера) документа для підписання
GET	/api/eds/doc/attachment/sign/info	Отримання інформації про підпис/підписантів
PATCH	/api/v2/eds/condra/reject	Відхилити «Універсальний/неструктурований документ» (CONDRA). Створення квитанції №13
PATCH	/api/v2/eds/condra/withdraw	Відкликати «Універсальний/неструктурований документ» (CONDRA). Створення квитанції №14
PATCH	/api/v2/eds/condra/confirm/send	Прийняти «Універсальний/неструктурований документ» (CONDRA)
DELETE	/api/eds/doc/attachment	Видалити файл-вкладення (чернетка)
GET	/api/eds/doc/attachment	Отримати файл-вкладення
POST	/api/eds/doc/attachment	Додати файл до документа-чернетки
PATCH	/api/eds/docs	Видалити документи-чернетки
POST	/api/v2/eds/doc/content	Отримати тіла документів (json) за вказаними UUID

Робота з квитанціями

Метод	URL запиту	Опис
GET	/api/eds/doc/tickets	Отримання всіх квитанцій вказаного документа
GET	/api/eds/doc/signers	Отримання інформації про підписантів
GET	/api/eds/doc/ticket/body	Отримання даних/контенту квитанції
GET	/api/v2/eds/comdoc/repeal	Створення на сервері квитанції «Анулювання» (COMDOC_019)
GET	/api/v2/eds/comdoc/reject	Створення на сервері квитанції «Повідомлення про відмову від підписання документу» (COMDOC_021) для COMDOC документів
GET	/api/v2/eds/doc/reject	Створення на сервері квитанції «Повідомлення про відмову від підписання документу» (COMDOC_021)
POST	/api/v2/eds/doc/ticket	Створення квитанції №1 (підпис чернетки)
POST	/api/v2/eds/comdoc/accept	Створення квитанції №2 (прийняття документа COMDOC)
POST	/api/v2/eds/comdoc/repeal	Створення квитанції №11 (запит на анулювання COMDOC)
POST	/api/v2/eds/comdoc/repeal/accept	Створення квитанції №12 (прийняття запиту на анулювання COMDOC)
POST	/api/v2/eds/comdoc/reject	Створення квитанції №13 (відхилення документа COMDOC)
POST	/api/v2/eds/comdoc/revoke	Створення квитанції №14 (відкликати підписання документа COMDOC)
POST	/api/v2/eds/comdoc/repeal/reject	Створення квитанції №15 (відмова від анулювання COMDOC)
POST	/api/v2/eds/doc/reject	Відправка відмови від підписання (створення квитанції №13)

Робота з тегами

Метод	URL запиту	Опис
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	Вилучити теги з документа

Робота з подіями (в тестуванні)

Примітка

1. Обираєте ідентифікатор документу, з якого Ви плануєте розпочати отримувати всі наступні події.

2. Надсилаєте запит на отримання останнього ідентифікатора події за документом.

3. В отриманному у відповідь об’єкті XEvent зберігаєте значення параметра id.

4. Надсилаєте запит для пошуку подій. В об’єкті запиту EventsStorageQuery, в параметрі fromId вказуєте ідентифікатор події який Ви отримали в пункті 3.

5. З отриманного у відповідь об’єкта EventsStorageQueryResult зберігаєте значення параметра lastEventId замість того, що зберегли в пункті 3.

6. Опрацьовуєте документи в EventsStorageQueryResult.

7. Якщо кількість значень в параметрі items об’єкта EventsStorageQueryResult:

   • дорівнює вказаному ліміту (limit) або рівне 100, то повторюйте операції з 4 по 7.

   • меньше вказаного ліміту (limit) або менше 100, то необхідно зробити паузу (1 хвилина) для подальшого виконання операцій з 4 по 7.

Метод	URL запиту	Опис
GET	/api/eds/docs/event/last	Отримати останню подію за документом
GET	/api/eds/docs/events	Отримати список подій
POST	/api/eds/docs/events	Пошук подій

Робота з файлами (вкладення до документа)

Метод	URL запиту	Опис
POST	/api/eds/doc/attachment	Додати файл до документа-чернетки
GET	/api/eds/doc/attachment	Отримати файл-вкладення
DELETE	/api/eds/doc/attachment	Видалити файл-вкладення (чернетка)

Погодження

Метод	URL запиту	Опис
POST	/api/eds/doc/approval/scenario	Створити сценарій погодження документів
GET	/api/eds/doc/approval/scenario	Отримати сценарій/-ії (на рівні GLN)
PUT	/api/eds/doc/approval/scenario	Редагувати / видалити сценарій погодження документів
POST	/api/eds/doc/approval/step	Запуск документа на погодження / Зміна статуса кроку погодження
GET	/api/eds/doc/approval/step	Отримання кроків погодження за документом

Загальні помилки при роботі з API (всі сервіси EDIN)

Код помилки	Опис	Рекомендовані дії
500	Не класифікована помилка	У випадку, якщо Ви отримали у тілі відповіді подібний текст “Internal Server Error. Channel ID: 45b696af”, то зверніться за допомогою до нашої тех. підтримки. Якщо Ви отримали інший текст помилки, то прочитайте її і спробуйте зрозуміти. В багатьох випадках, проблема буде описана.
502	Сервер не відповідає	Перевірте ваше інтернет з’єднання. Якщо все гаразд, то спробуйте повторити раніше надісланий запит.
504	Тайм-аут отримання відповіді з сервера	У випадку надсилання запиту, що змінює дані (наприклад, підписання документа) ми рекомендуємо перевіряти виконання попереднього запиту (наприклад, чи був доданий підпис). З затримкою в 5 секунд надішліть запит для перевірки виконання Вашого попереднього запиту. Якщо Ваш попередній запит не виконався з будь-яких причин, повторіть його.
520	Сервісна помилка	Запит не був опрацьований нашими серверами. З затримкою в 5 секунд, повторіть Ваш запит.
521	Сервісна помилка	Запит не був опрацьований нашими серверами. З затримкою в 5 секунд, повторіть Ваш запит.
522	Сервісна помилка	Запит не був опрацьований нашими серверами. З затримкою в 5 секунд, повторіть Ваш запит.
523	Сервісна помилка	Запит не був опрацьований нашими серверами. З затримкою в 5 секунд, повторіть Ваш запит.
524	Сервісна помилка	Запит не був опрацьований нашими серверами. З затримкою в 5 секунд, повторіть Ваш запит.
525	Сервісна помилка	Запит не був опрацьований нашими серверами. З затримкою в 5 секунд, повторіть Ваш запит.
526	Сервісна помилка	Запит не був опрацьований нашими серверами. З затримкою в 5 секунд, повторіть Ваш запит.