API по роботі з довідниками

Перелік методів API по роботі з довідниками

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

Для роботи з цими методами користувач повинен бути авторизованим.

Робота з об'єднаним віртуальним довідником (всі сервіси в рамках акаунта/користувача)
Отримати значення з віртуального довідника 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
Робота з іншими довідниками
Отримати інформацію по авторизованому користувачу GET /api/oas/user
Отримати інформацію про всіх користувачів компанії (на рівні акаунта) GET /api/oas/account/users
Отримати інформацію по GLN-номерам, пов'язаним з авторизованим користувачем (на рівні акаунта) GET /api/oas/account/identifiers
Отримати перелік роздрібних мереж, пов'язаних із заданим GLN GET /api/oas/retailers
Отримати перелік GLN-номерів, пов'язаних із заданою роздрібною мережею GET /api/oas/retailer/identificators
Отримати перелік всіх мереж, пов'язаних з авторизованим користувачем GET /api/oas/allretailers
Отримати перелік доступних одиниць виміру GET /api/oas/units
Отримати інформацію про організацію по Назві/ІПН/КПП/GLN GET /api/oas/identifiers


Отримати інформацію про організацію по Назві/ІПН/КПП/GLN GET /api/oas/identifiers

Метод дозволяє користувачеві переглядати додаткову інформацію про інші організації на рівні одного загального акаунта, а також знайти Основний GLN за Додатковим GLN.

Основний GLN має унікальний ЄДРПОУ на рівні платформи. Використовується для документів, що потребують дані юридичної особи та подальшого підписання КЕП. Створюється автоматично при реєстрації на платформі EDI Network.

Додатковий GLN підв’язується до «Основного GLN». Використовується для указання точок доставки, дрібних магазинів і т.і.

При заповненні GLN у ТТН перевірте правильність формату адреси «Правила заповнення адрес у ТТН та Актах на основі даних із GLN»

REQUEST

URL

Метод запиту

GET

URL запиту

/api/oas/identifiers

URL параметри

gln (обов’язково) String (13) - GLN власної Компанії;

query (опціонально) String - текст пошуку (пошук здійснюється за назвою/ІПН/КПП/GLN організації);

with_parents (опціонально) boolean - при true значенні у відповідь передаються дані Основного GLN при наявності (параметр parentIdentificator);

child_gln (опціонально) GLN - значення Додаткового GLN; якщо передається даний параметр, то у відповідь повертаються дані Основного GLN, з яким встановлено зв’язок за Додатковим GLN;

account_id (опціонально) String - ідентифікатор акаунта Компанії. В комбінаціях з account_id параметром можуть застосовуватись додаткові фільтри:

  • katottg_required (опціонально) boolean - при true значенні пошук здійснюється лише по записах з заповненим значенням коду КАТОТТГ;

  • is_company (опціонально) boolean - при true значенні пошук здійснюється лише за Основним GLN компанії;

  • driver_license_required (опціонально) boolean - при true значенні пошук здійснюється лише по записах з вказаним водійським посвідченням

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

В тілі відповіді передається інформація про організацію (масив об’єктів Identificator).

Отримати перелік доступних одиниць виміру GET /api/oas/units

Метод дозволяє відобразити довідник одиниць виміру.

REQUEST

URL

Метод запиту

GET

URL запиту

/api/oas/units

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

В тілі відповіді передається довідник одиниць виміру.

Отримати перелік всіх мереж, пов’язаних з авторизованим користувачем GET /api/oas/allretailers

REQUEST

   

Метод запиту

GET

URL запиту

/api/oas/allretailers

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

В тілі відповіді передається інформація по мережах у вигляді масиву об’єктів.

Отримати перелік GLN номерів, пов’язаних із заданою роздрібною мережею GET /api/oas/retailer/identificators

REQUEST

URL

Метод запиту

GET

URL запиту

/api/oas/retailer/identificators

URL параметри

retailer_id - число; ідентифікатор роздрібної мережі (параметр retailerId з попередніх методів)

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

В тілі відповіді передаються дані про контрагентів (масив об’єктів Identificator).

Отримати перелік роздрібних мереж, які пов’язані із заданим GLN GET /api/oas/retailers

За допомогою цього метода можна отримати перелік всіх роздрібних мереж-контрагентів користувача.

REQUEST

URL

Метод запиту

GET

URL запиту

/api/oas/retailers

URL параметри

gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

В тілі відповіді передається інформація про роздрібні мережі.

Отримати інформацію по GLN номерам, пов’язаним з авторизованим користувачем (на рівні акаунта) GET /api/oas/account/identifiers

Метод дозволяє користувачеві переглядати додаткову інформацію про інших користувачів на рівні одного загального акаунта.

REQUEST

URL

Метод запиту

GET

URL запиту

/api/oas/account/identifiers

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

В тілі відповіді передається інформація по GLN номерам у вигляді масиву об’єктів Identificator.

Отримати інформацію про всіх користувачів компанії (на рівні акаунта) GET /api/oas/account/users

REQUEST

URL

Метод запиту

GET

URL запиту

/api/oas/account/users

URL параметри

type (опціонально) String - тип очікуваної відповіді; можливі варіанти:

  • full (за замовчуванням)

  • short

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

В тілі відповіді передається інформація про користувачів (масив об’єктів User).

Отримати інформацію по авторизованому користувачу GET /api/oas/user

За допомогою цього метода можна отримати інформацію про користувача, наприклад ID користувача, ID акаунта, логін, чи має користувач «права адміністратора» (true / false), дані про платформу та інші ідентифікатори.

REQUEST

URL

Метод запиту

GET

URL запиту

/api/oas/user

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

В тілі відповіді передається інформація про користувача (об’єкт User).

Видалити значення з довідника DELETE /api/uds/dictionary/values

REQUEST

URL

  

Метод запиту

DELETE

URL запиту

/api/uds/dictionary/values

URL параметри

dict_id (обов’язково) String - ідентифікатор довідника

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту методу передається масив з номером значення із довідника, яке потрібно видалити, наприклад: [23]

RESPONSE

Код сервера 200 (ok).

Додати значення в довідник POST /api/uds/dictionary/values

REQUEST

URL

  

Метод запиту

POST

URL запиту

/api/uds/dictionary/values?dict_id=3

URL параметри

dict_id (обов’язково) String - ідентифікатор довідника

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту методу передається масив об’єктів зі значеннями віртуального довідника

RESPONSE

Код сервера 200 (ok).

Видалити довідник DELETE /api/uds/dictionary

REQUEST

URL

  

Метод запиту

DELETE

URL запиту

/api/uds/dictionary

URL параметри

dict_id (обов’язково) String - ідентифікатор довідника

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

Код сервера 200 (ok).

Оновити довідник PUT /api/uds/dictionary

При оновленні довідника всі його дані перезаписуються на нові з тіла запиту.

REQUEST

URL

  

Метод запиту

PUT

URL запиту

/api/uds/dictionary

URL параметри

dict_id (обов’язково) String - ідентифікатор довідника

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту методу передається масив об’єктів зі значеннями віртуального довідника

RESPONSE

Код сервера 200 (ok).

Створити новий довідник POST /api/uds/dictionary

Важливо! При створенні довідник одразу наповнюється даними.

REQUEST

URL

  

Метод запиту

POST

URL запиту

/api/uds/dictionary

URL параметри

name (обов’язково) - рядок; назва довідника:

  • TRANSPORT - транспортні засоби

  • TTN_RESPONSIBLE_PERSONS - відповідальні особи

  • comdoc_responsible - відповідальні особи

type (обов’язково) - рядок; рівень довідника:

  • user - поточний користувач

  • account - поточний акаунт

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту методу передається масив об’єктів зі значеннями віртуального довідника

RESPONSE

У тілі відповіді передається об’єкт з dict_id - ідентифікатором нового довідника:

{"dict_id":2}

 

Отримати значення з віртуального довідника GET /api/uds/dictionary

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/uds/dictionary

URL параметри

name (обов’язково) - рядок; назва довідника:

  • TRANSPORT - транспортні засоби

  • TTN_RESPONSIBLE_PERSONS - відповідальні особи

  • comdoc_responsible - відповідальні особи

type (обов’язково) - рядок; рівень довідника:

  • user - поточний користувач

  • account - поточний акаунт

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

В тілі відповіді в залежності від параметрів запиту передається об’єкт зі значеннями з віртуального довідника в json форматі.