Загальні методи
Для роботи з методами користувач повинен бути авторизованим.
Завантаження тіла документа у форматі JSON/XML/ECMR/PDF/ZIP
GET /api/eds/doc/ettn/body
Метод використовується для всіх оновлених документів сервісу «ЕТТН»
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
GET |
|
URL запиту |
/api/eds/doc/ettn/body |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі doc_uuid (обов’язково) UUID - ідентифікатор документа response_type (опціонально) String - тип формату, в якому будуть передаватись дані (для зручності подальшого опрацювання); можливі варіанти:
file_name (опціонально) - String; назва файлу для завантаження. Якщо вказано, то при response_type = format (опціонально) - String; формат файлу для отримання/завантаження (якщо не вказано - ZIP); можливі варіанти:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
У тілі відповідь передається документ сервісу «ЕТТН» в визначеному запитом форматі (Специфікації документів).
Підписання даних сервісу (збереження підпису)
POST /api/eds/doc/ettn/sign
Формат підпису повинен відповідати стандарту CAdES-X Long (детальніше — у специфікації)
Підписання в сервісі «ЕТТН» можна здійснювати двома способами:
Через ECMR тіло документа
Отримати тіло документа сервісу «ЕТТН» у форматі ECMR.
Підписати отримане ECMR тіло (результат — p7s-файл підпису).
Конвертувати p7s у base64 — цей результат передається у масиві тіла запиту.
Через sign_hash (extra_fields)
Отримати
sign_hash(extra_fields) документа сервісу «ЕТТН».Підписати значення
sign_hash(результат — p7s-файл підпису).Конвертувати p7s у base64 — цей результат передається у масиві тіла запиту.
Перепідписання документа (оновлення підпису повторним викликом методу) дозволяється лише до моменту відправки документа контрагенту.
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
POST |
|
URL запиту |
/api/eds/doc/ettn/sign |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі role_code (обов’язково) String - код ролі учасника-підписанта:
doc_uuid (обов’язково) UUID - ідентифікатор документа |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передається масив файлів підпису p7s в base64 форматі. |
Приклад тіла запиту:
["ZGZkZmRmZGZkZmRmdnh2dmM==", "ZGZkZmRmZGZkZmRmdnh2dmM=="]RESPONSE
Код сервера 200 (ok).
Отримання всіх квитанцій вказаного документа
GET /api/eds/doc/tickets
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
GET |
|
URL запиту |
/api/eds/doc/tickets |
|
URL параметри |
gln (обов’язково) - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта; АБО guid (обов’язково) - рядок; унікальний ідентифікатор організації в системі doc_uuid (обов’язково) - рядок; UUID документа loadBody (опціонально) - отримати квитанції разом з їх тілами; можливі значення: loadBody type (опціонально) - тип отримання даних; можливі значення: zip - у вигляді архіву (при цьому обов’язково вказується назва архіву - параметр file_name) file_name - назва архіву (вказується при наявності параметра type) family (опціонально) - сімейство; можливі значення: edi |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json or application/zip |
RESPONSE
В тілі відповіді залежно від наявності параметра type передається масив об’єкта XTicket (квитанції вказаного документа) в json форматі чи у вигляді zip-архіву.
Отримання інформації (мета-даних) про документ
GET /api/eds/doc
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
GET |
|
URL запиту |
/api/eds/doc |
|
URL параметри |
gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта; АБО guid - рядок; унікальний ідентифікатор організації в системі doc_uuid - рядок; UUID документа |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
У тілі відповідь передаються дані вказаного документа (об'єкт XDoc).
Отримання інформації про підписантів е-ТТН та Актів v3 (family=7)
GET /api/eds/doc/ettn/sign/info
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
GET |
|
URL запиту |
/api/eds/doc/ettn/sign/info |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії doc_uuid (обов’язково) UUID - ідентифікатор документа |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається інформація про підписантів (об’єкт SignsPackageV2).
Видалити документи-чернетки
PATCH /api/eds/docs
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
PATCH |
|
URL запиту |
/api/eds/docs |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; family (опціонально) UUID - сервіс/сімейство документів; можливі значення: edi detailed_response (опціонально) boolean - false за замовчуванням; при detailed_response = true, то у відповідь повернеться додатково статус видалення по кожному документу (success/failed) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передається масив ідентифікаторів документів-чернеток до видалення, наприклад: |
RESPONSE
Код сервера 200 (ok).
Пошук транспортного засобу у власному довіднику транспортних засобів
GET /api/oas/v2/transport
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
GET |
|
URL запиту |
/api/oas/v2/transport |
|
URL параметри |
transport_number (обов’язково) String - номер транспортного засобу (у літеро сполученні допускається лише латинниця) від 4 символів. Так номер AA0001AA користувач може знайти за |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
У тілі відповіді з довідника передаються дані знайдених транспортних засобів (масив об'єкта Transport).
Створення нового транспортного засобу в довіднику
POST /api/oas/v2/transport
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
POST |
|
URL запиту |
/api/oas/v2/transport |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу (в json форматі) передаються дані нового транспортного засобу (об'єкт Transport). |
RESPONSE
Код сервера 200 (ok).
Видалення чернетки транзакції
DELETE /api/eds/doc/ettn/draft_ticket
Метод призначений для видалення чернетки транзакції, створеної з помилками, до документа.
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
DELETE |
|
URL запиту |
/api/eds/doc/ettn/draft_ticket |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії doc_uuid (обов’язково) UUID - ідентифікатор документа, до якого створено чернетку |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
Код сервера 200 (ok).
No comments to display
No comments to display