API
Алгоритми обміну документами в сервісі Е-СПЕЦИФІКАЦІЯ (API)
Після погодження (обоюдного підписання) «Товарної специфікації» (COMDOC_008) реалізована автоматична відправка документа «Електронна специфікація» (PRODUCTLIST) з урахуванням усіх погоджених змін. Мережа при цьому отримує документ через FTP сервіс EDIN. Перегляд усіх Cпецифікацій / Переглянути Специфікацію з конкретним контрагентом.
Підказка
Всі запити нижче перерахованих API методів сервісу направляються на адресу: https://edo-v2.edin.ua
Налаштування рівнів погодження (тільки для Мережі)
Метод |
URL запиту |
Опис |
---|---|---|
GET |
|
Отримання інформації про всіх користувачів компанії (на рівні акаунта) |
GET |
|
Отримати всі пов’язані GLN користувача в сервісі «Е-Специфікація» |
GET |
|
Отримати всі статуси документів, в яких документи доступні користувачу до перегляду |
GET |
|
Отримати всі активні GLN користувача (за якими відображаються категорії товарів) |
GET |
|
|
POST |
|
Вказати нові статуси документів, в яких документи будуть доступні користувачу до перегляду |
POST |
|
Вказати нові активні GLN користувача (за якими відображаються категорії товарів) |
POST |
|
Вказати нові дії узгодження для вказаного користувача в розрізі кожного підтипу документа AGREEM |
Робота з контрактами / специфікаціями
Метод |
URL запиту |
Опис |
---|---|---|
POST |
|
|
PUT |
|
|
GET |
|
|
GET |
|
|
DELETE |
|
|
POST |
|
Робота з пропозиціями
Метод |
URL запиту |
Опис |
---|---|---|
GET |
|
|
GET |
|
|
GET |
|
|
POST |
|
|
PUT |
|
|
POST |
|
|
GET |
|
Отримати тіло документа (комерційної пропозиції / товарного узгодження) |
PUT |
|
Оновити тіло документа (комерційної пропозиції / товарного узгодження) |
DELETE |
|
|
DELETE |
|
Видалити вкладення (обгрунтування) пропозиції товарного переузгодження |
GET |
|
Отримати список вкладень до пропозиції товарного переузгодження чи конкретного коментаря документа |
GET |
|
Отримати контент файлу-вкладення товарного узгодження чи коментаря |
POST |
|
Додати обгрунтування до пропозиції товарного переузгодження (Постачальник) |
PATCH |
|
|
PATCH |
|
|
GET |
|
|
PUT |
|
|
POST |
|
|
GET |
|
|
PATCH |
|
Приймання/Відхилення позицій «Товарного узгодження» (Мережа) |
PATCH |
|
|
POST |
|
|
PATCH |
|
Відправити підписаний документ «Товарна специфікація» (Мережа) |
GET |
|
Отримати XML контента документа «Товарна специфікація» (Мережа) |
Робота з коментарями
Метод |
URL запиту |
Опис |
---|---|---|
POST |
|
|
GET |
|
Робота зі статусами
Метод |
URL запиту |
Опис |
---|---|---|
PUT |
|
Оновити статус документа (комерційної пропозиції / товарного узгодження) |
PUT |
|
Загальні помилки при роботі з API (всі сервіси EDIN)
Код відповіді |
Індекс помилки |
Текст помилки |
Опис |
400 |
ERR_CMN-1 |
Parameter(s) [%s] is(are) required Параметр(и) [%s] є обов’язковим(и) |
Помилка виникає, якщо не передати обовязковий url-параметр (наприклад, doc_uuid) |
400 |
ERR_CMN-2 |
Unknown or unsupported %s [%s] Непідтримуваний %s [%s] |
Помилка виникає, якщо вказаний параметр не підтримується (наприклад, передавати response_type=xml, але доступні тільки - file, base64, bytes) |
400 |
ERR_CMN-3 |
Parameter [%s] must have format format: [%s] Параметер [%s] повинен мати формат: [%s] |
Помилка виникає, коли клієнт в url параметрі передав значення, в форматі, що не підтимується |
400 |
ERR_CMN-4 |
Incorrect Content-Type in request, one of [%s] is expected Некоректний Content-Type. Очікується один з наступних: |
|
400 |
ERR_CMN-5 |
Unsupported method [%s] Непідтримуваний метод [%s] |
|
400 |
ERR_CMN-6 |
Expected [%s] file(s) in multipart/form data Очікується [%s] файл(и)ів у multipart/form data |
|
400 |
ERR_CMN-7 |
Request body is empty Тіло запиту порожнє |
|
400 |
ERR_CMN-7 |
Unknown gln: [%s] Невідомий gln: [%s] |
|
400 |
ERR_CMN-8 |
Supported not more [%s] files per request Підтримується не більше [%s] файлів на запит |
|
400 |
ERR_CMN-9 |
Exceeded max file name length Перевищено максимальну довжину імені файлу |
|
400 |
ERR_CMN-10 |
Exceeded max file size - [%s] Перевищено максимальний розмір файлу - [%s] |
|
400 |
ERR_CMN-11 |
Action not available, reason - [%s] Дія не доступна, причина - [%s] |
Помилка виникає в різних випадках, наприклад, коли відправник документа CONDRA хоче її прийняти, але це може зробити тільки отримувач документа |
400 |
ERR_CMN-12 |
Document with identifier [%s] not found Документ з ідентифікатором [%s] не знайдено |
|
400 |
ERR_CMN-12 |
Chain with identifier [%s] not found Ланцюг з ідентифікатором [%s] не знайдено |
|
400 |
ERR_CMN-13 |
Attachment with identifier [%s] not found Вкладення з ідентифікатором [%s] не знайдено |
|
400 |
ERR_CMN-14 |
Ticket not found Квитанцію не знайдено |
|
400 |
ERR_CMN-15 |
Package with identifier [%s] not found Пакет з ідентифікатором [%s] не знайдено |
|
400 |
ERR_CMN-16 |
Incorrect format of field’s value Некоректний формат значення поля |
|
400 |
ERR_CMN-17 |
error |
Помилка в роботі процедури (БД) |
400 |
ERR_CMN-18 |
Document body already exist Тіло документа вже існує |
Дублювання тіла документа |
400 |
ERR_CMN-19 |
Transformer for document type [%s] not found Перетворювач для типу документа [%s] не знайдено |
Не вдалось знайти компонент для перетворення xml в json / json в xml і т.д. |
400 |
ERR_CMN-20 |
Transforming error Помилка перетворення |
Помилка при перетворенні, наприклад: при перетворенні xml в json, коли xml не відповідає специфікації документа |
400 |
ERR_CMN-21 |
Malformed JSON Невірно сформований JSON |
Неправильні дані / некоректний формат в полі json |
Код помилки |
Опис |
Рекомендовані дії |
500 |
Не класифікована помилка |
У випадку, якщо Ви отримали у тілі відповіді подібний текст “Internal Server Error. Channel ID: 45b696af”, то зверніться за допомогою до нашої тех. підтримки. Якщо Ви отримали інший текст помилки, то прочитайте її і спробуйте зрозуміти. В багатьох випадках, проблема буде описана. |
502 |
Сервер не відповідає |
Перевірте ваше інтернет з’єднання. Якщо все гаразд, то спробуйте повторити раніше надісланий запит. |
504 |
Тайм-аут отримання відповіді з сервера |
У випадку надсилання запиту, що змінює дані (наприклад, підписання документа) ми рекомендуємо перевіряти виконання попереднього запиту (наприклад, чи був доданий підпис). З затримкою в 5 секунд надішліть запит для перевірки виконання Вашого попереднього запиту. Якщо Ваш попередній запит не виконався з будь-яких причин, повторіть його. |
520 |
Сервісна помилка |
Запит не був опрацьований нашими серверами. З затримкою в 5 секунд, повторіть Ваш запит. |
521 |
Сервісна помилка |
Запит не був опрацьований нашими серверами. З затримкою в 5 секунд, повторіть Ваш запит. |
522 |
Сервісна помилка |
Запит не був опрацьований нашими серверами. З затримкою в 5 секунд, повторіть Ваш запит. |
523 |
Сервісна помилка |
Запит не був опрацьований нашими серверами. З затримкою в 5 секунд, повторіть Ваш запит. |
524 |
Сервісна помилка |
Запит не був опрацьований нашими серверами. З затримкою в 5 секунд, повторіть Ваш запит. |
525 |
Сервісна помилка |
Запит не був опрацьований нашими серверами. З затримкою в 5 секунд, повторіть Ваш запит. |
526 |
Сервісна помилка |
Запит не був опрацьований нашими серверами. З затримкою в 5 секунд, повторіть Ваш запит. |