Skip to main content

Підписки на події

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

Отримання даних про підписки на події / Отримання даних про підпис особи

GET /api/mintrans/subscribe
REQUEST

URL

https://edo-v2.edin.ua

Метод запиту

GET

URL запиту

/api/mintrans/subscribe

URL параметри

gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі

sign_info (опціонально) Boolean - при sign_info=true в тілі відповіді передаються дані про підпис особи, що оформила підписку (не дані про підписку)

Headers

 

Authorization

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

Content-Type

application/json

RESPONSE

У тілі відповіді передаються дані підписок (масив об’єктів mintransSubscription) або дані про підпис особи, що оформила підписку (об’єкт ExEndUserSignInfo), якщо в методі передається параметр sign_info.

Створення підписки про події (отримання документів)

POST /api/mintrans/subscribe
REQUEST

URL

 https://edo-v2.edin.ua

Метод запиту

POST

URL запиту

/api/mintrans/subscribe

URL параметри

gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі

Headers

 

Authorization

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

Content-Type

application/json

REQUEST

 

JSON Body

В тілі запиту методу в base64 форматі передається підписаний рядок «yes» (попередньо підписуємо рядок «yes» -> отримуємо p7s файл підпису -> конвертуємо p7s в base64 формат)

RESPONSE

У тілі відповіді передаються дані підписки (об’єкт mintransSubscription).

Видалення підписки на події (отримання документів)

DELETE /api/mintrans/subscribe
REQUEST

URL

 https://edo-v2.edin.ua

Метод запиту

DELETE

URL запиту

/api/mintrans/subscribe

URL параметри

gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі

Headers

 

Authorization

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

Content-Type

application/json

REQUEST

 

JSON Body

В тілі запиту методу в base64 форматі передається підписаний рядок «yes» (попередньо підписуємо рядок «yes» -> отримуємо p7s файл підпису -> конвертуємо p7s в base64 формат)

RESPONSE

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

Отримання списку подій з ЦБД

GET /api/mintrans/events

 

REQUEST

URL

 https://edo-v2.edin.ua

Метод запиту

GET

URL запиту

/api/mintrans/events

URL параметри

gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі;

date_from (обов’язково) long - дата (unix timestamp), починаючи з якої буде робитись вибірка;

limit (опціонально) int - ліміт вибірки (за замовчуванням=50);

offset (опціонально) int - зміщення відносно верхньої межі вибірки (за замовчуванням=0)

Headers

 

Authorization

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

Content-Type

application/json

RESPONSE

У тілі відповіді передаються дані подій з ЦБД (масив об’єктів EttnV3Event).

Отримання документа з ЦБД

GET /api/mintrans/doc

 

REQUEST

URL

 https://edo-v2.edin.ua

Метод запиту

GET

URL запиту

/api/mintrans/doc

URL параметри

gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі

mintrans_doc_id (обов’язково) String - ідентифікатор документа (documentId з методу отримання даних подій)

Headers

 

Authorization

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

Content-Type

application/json

RESPONSE

У тілі відповіді передаються дані документа з ЦБД (об’єкт EttnV3MintransDoc).