API v2

Алгоритми обміну документами (API)
- Алгоритм «Прайс-лист» (PRICAT)
- Алгоритм «Замовлення» (ORDER)
- Алгоритм «Підтвердження замовлення» (ORDRSP)
- Алгоритм «Повідомлення про відвантаження» (DESADV)
- Алгоритм «Повідомлення про прийом» (RECADV)
- Алгоритм «Видаткова накладна» (COMDOC_006)
- Алгоритм «Акт про виявлені недоліки» (COMDOC_005)
- Алгоритм «Коригування видаткової накладної» (COMDOC_038)
Підказка
Всі запити нижче перерахованих API методів платформи EDIN 2.0 направляються на адресу: https://edo-v2.edin.ua
Робота з довідниками
Метод |
URL запиту |
Опис |
---|---|---|
GET |
|
|
GET |
|
Отримання інформації про всіх користувачів компанії (на рівні акаунта) |
GET |
|
Отримання інформації по GLN номерами, пов’язаним з авторизованим користувачем (на рівні акаунта) |
GET |
|
Отримання переліку роздрібних мереж, які пов’язані із заданим GLN |
GET |
|
Отримання переліку GLN номерів, які пов’язані із заданою роздрібною мережею |
GET |
|
|
GET |
|
|
GET |
|
Робота з об’єднаним віртуальним довідником (всі сервіси в рамках акаунта/користувача)
Метод |
URL запиту |
Опис |
---|---|---|
GET |
|
|
POST |
|
|
PUT |
|
|
DELETE |
|
|
POST |
|
|
DELETE |
|
Робота з документами
Метод |
URL запиту |
Опис |
---|---|---|
POST |
|
|
PATCH |
|
|
POST |
|
|
POST |
|
|
GET |
|
|
GET |
|
|
GET |
|
|
GET |
|
|
GET |
|
|
GET |
|
Завантажити «Неструктурований (універсальний) документ» (CONDRA) в вигляді архіву |
PATCH |
|
Відправка «Неструктурованого (універсального) документа» (CONDRA) |
POST |
|
Створення чернетки «Універсального/неструктурованого документа» (CONDRA) |
POST |
|
Створення й відправка «Універсального/неструктурованого документа» (CONDRA) без створення чернетки |
POST |
|
|
GET |
|
|
POST |
|
|
POST |
|
Створення чернетки документа (для CONDRA та TRANSPORTATIONORDER) |
PUT |
|
|
GET |
|
|
POST |
|
|
PUT |
|
Заповнення індексів (додавання / оновлення полей екстрапараметрів) |
PATCH |
|
|
GET |
|
|
GET |
|
|
POST |
|
|
GET |
|
Отримати хеш вкладення (контейнера) документа для підписання |
GET |
|
|
PATCH |
|
Відхилити «Універсальний/неструктурований документ» (CONDRA). Створення квитанції №13 |
PATCH |
|
Відкликати «Універсальний/неструктурований документ» (CONDRA). Створення квитанції №14 |
PATCH |
|
|
DELETE |
|
|
GET |
|
|
POST |
|
|
PATCH |
|
|
POST |
|
Робота з квитанціями
Метод |
URL запиту |
Опис |
---|---|---|
GET |
|
|
GET |
|
|
GET |
|
|
GET |
|
|
GET |
|
|
GET |
|
Створення на сервері квитанції «Повідомлення про відмову від підписання документу» (COMDOC_021) |
POST |
|
|
POST |
|
|
POST |
|
|
POST |
|
Створення квитанції №12 (прийняття запиту на анулювання COMDOC) |
POST |
|
|
POST |
|
Створення квитанції №14 (відкликати підписання документа COMDOC) |
POST |
|
|
POST |
|
Робота з тегами
Метод |
URL запиту |
Опис |
---|---|---|
POST |
|
|
GET |
|
|
PUT |
|
|
DELETE |
|
|
POST |
|
|
DELETE |
|
Робота з подіями (в тестуванні)
Примітка
Обираєте ідентифікатор документу, з якого Ви плануєте розпочати отримувати всі наступні події.
Надсилаєте запит на отримання останнього ідентифікатора події за документом.
В отриманному у відповідь об’єкті XEvent зберігаєте значення параметра id.
Надсилаєте запит для пошуку подій. В об’єкті запиту EventsStorageQuery, в параметрі fromId вказуєте ідентифікатор події який Ви отримали в пункті 3.
З отриманного у відповідь об’єкта EventsStorageQueryResult зберігаєте значення параметра lastEventId замість того, що зберегли в пункті 3.
Опрацьовуєте документи в EventsStorageQueryResult.
Якщо кількість значень в параметрі items об’єкта EventsStorageQueryResult:
дорівнює вказаному ліміту (limit) або рівне 100, то повторюйте операції з 4 по 7.
меньше вказаного ліміту (limit) або менше 100, то необхідно зробити паузу (1 хвилина) для подальшого виконання операцій з 4 по 7.
Метод |
URL запиту |
Опис |
---|---|---|
GET |
|
|
GET |
|
|
POST |
|
Робота з файлами (вкладення до документа)
Метод |
URL запиту |
Опис |
---|---|---|
POST |
|
|
GET |
|
|
DELETE |
|
Погодження
Метод |
URL запиту |
Опис |
---|---|---|
POST |
|
|
GET |
|
|
PUT |
|
|
POST |
|
Запуск документа на погодження / Зміна статуса кроку погодження |
GET |
|
Загальні помилки при роботі з 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 секунд, повторіть Ваш запит. |