Робота з «Універсальним/неструктурованим документом» (CONDRA)
Всі запити нижче перерахованих API методів платформи EDIN 2.0 направляються на адресу: https://edo-v2.edin.ua
Для роботи з цими методами користувач повинен бути авторизованим.
Завантажити «Неструктурований (універсальний) документ» (CONDRA) в вигляді архіву
GET /api/eds/doc/condra/body
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/eds/doc/condra/body?gln=9864232319979&doc_uuid=b48aae9a-003a-453f-a40d-46d90181cdc7&file_name=wewerwer.pdf&file_type=zip |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії doc_uuid (обов’язково) UUID - ідентифікатор документа file_name (обов’язково) String - назва файлу документа |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/octet-stream |
RESPONSE
У тілі відповіді передається архів (.zip), що містить тіло документа CONDRA (.xml), файли-вкладення (оригінали або контейнери тіл підпису (.p7s) + листи підписання кожного вкладення (.pdf), якщо вкладення з підписами).
Відправка «Неструктурованого (універсального) документа» (CONDRA)
PATCH /api/eds/doc/condra/send
Наявність ритейлера при документообізі автоматично визначається платформою (тобто якщо Відправник або Одержувач є ритейлером, то створений ланцюжок буде мати позначку конкретного ритейлера).
REQUEST
|
URL |
|
|
Метод запиту |
PATCH |
|
URL запиту |
/api/eds/doc/condra/send?partner_id=0&gln=9864067620417&doc_uuid=226907d8-dacd-475e-9521-8a998825cc46&doc_hash=133BF38FC2763511E284879177A3F111&chain_hash=51F061AF9D41407AFCCBD1B7E089CE8E |
|
URL параметри |
gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта АБО guid - рядок; унікальний ідентифікатор організації в системі doc_uuid - рядок; UUID документа doc_hash (опціонально) - рядок; хеш документа chain_hash (опціонально) - рядок; хеш ланцюжка chain_uuid (опціонально) - рядок; ID ланцюжка partner_id (опціонально) - число; id торгової мережі (можливо отримати з довідника торгових мереж) chain_type (опціонально) - число; тип ланцюжка документів;
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
text/plain; charset=UTF-8 |
RESPONSE
Код сервера 200 (ok).
Створення чернетки «Універсального/неструктурованого документа» (CONDRA)
POST /api/v2/eds/doc/condra/create
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/v2/eds/doc/condra/create?gln=9864232319962&recipient=9864232319979&number=145-97f4-aa7ff1&date=2021-06-15&doctype=1502&contractNumber=contractNumber_2&contractDate=2021-06-15&summ=30000&delivery=9864232319962 |
|
URL параметри |
gln (обов’язково) String (13) - номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта recipient (обов’язково) String (13) - GLN отримувача number (обов’язково) String (32) - номер документа date (обов’язково) YYYY-MM-DD - дата документа doctype (обов’язково) String (1000) - код підтипа документа contractNumber (опціонально) String (16) - номер договору contractDate (опціонально) YYYY-MM-DD - дата договору summ (опціонально) Число десяткове - сума документа delivery (опціонально) String (13) - GLN місця доставки |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
|
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передаються підписані чи непідписані файли-вкладення (не більше 10 файлів з розміром файлу не більше 5 Мб) в їх нативному форматі (розширення файлу змінювати не потрібно). Приклади запитів + специфікація документа CONDRA. |
RESPONSE
doc_uuid - ідентифікатор документа на платформі EDIN 2.0;
JSON приклад відповіді:
{
"doc_uuid": "a066f658-e7fa-407d-b4bf-4b044fe5cc88"
}
Створення й відправка «Універсального/неструктурованого документа» (CONDRA) без створення чернетки
POST /api/v2/eds/doc/condra/create_and_send
За допомогою цього методу відбувається одночасне створення та відправка «Універсального/неструктурованого документа» (CONDRA).
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/v2/eds/doc/condra/create_and_send?gln=9864065732181&recipient=9864065732211&number=145-97f4-aa7ff1&date=2021-06-15&doctype=1502&contractNumber=contractNumber_2&contractDate=2021-06-15&summ=30000 |
|
URL параметри |
gln (обов’язково) String (13) - номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта recipient (обов’язково) String (13) - GLN отримувача number (обов’язково) String (32) - номер документа date (обов’язково) YYYY-MM-DD - дата документа doctype (обов’язково) String (1000) - код підтипа документа contractNumber (опціонально) String (16) - номер договору contractDate (опціонально) YYYY-MM-DD - дата договору summ (опціонально) Число десяткове - сума документа delivery (опціонально) String (13) - GLN місця доставки |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
|
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передаються підписані чи непідписані файли-вкладення (не більше 10 файлів з розміром файлу не більше 5 Мб) в їх нативному форматі (розширення файлу змінювати не потрібно). Приклади запитів + специфікація документа CONDRA. |
RESPONSE
doc_uuid - ідентифікатор документа на платформі EDIN 2.0;
chain_uuid - ідентифікатор ланцюжка, в якому знаходиться документ.
JSON приклад відповіді:
{
"doc_uuid": "0ca98f00-6988-4aac-a660-8f289a24fe2d",
"chain_uuid": "4838e8fe-c0aa-4fe9-ad78-74832d9e2b59"
}
Додавання файлу-вкладення (для CONDRA)
POST /api/eds/doc/body
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/eds/doc/body?body_type=content&doc_uuid=37c753a5-7746-4e3f-8485-332c16b63f83&gln=9864067620417&family=edi |
|
URL параметри |
gln (обов’язково) рядок (13) - номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні аккаунта АБО guid (обов’язково) String - унікальний ідентифікатор організації на платформі EDIN 2.0 doc_uuid (обов’язково) UUID - ідентифікатор документа family (опціонально) int - сервіс (сімейство); допустимі значення:
body_type (обов’язково) String - тип тіла документа; можливі значення:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/pkcs7-signature – для p7s файла application/vnd.openxmlformats-officedocument.spreadsheetml.sheet – для Excel … etc MIME типізація |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передається тіло файла в бінарному вигляді. |
RESPONSE
Код сервера 200 (ok).
Створення чернетки документа (для CONDRA)
POST /api/eds/doc
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/eds/doc?doc_type=condra&doc_number=weba1&doc_date=1614636000&gln=9864067620417&recipient=9864067620424&family=edi |
|
URL параметри |
gln (обов’язково) String (13) - номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні аккаунта АБО guid (обов’язково) String - унікальний ідентифікатор організації на платформі EDIN 2.0 doc_type (обов’язково) String - тип документа (опис параметру) doc_number (обов’язково) String - номер документа doc_date (обов’язково) число - дата документа (в форматі UNIX-timestamp) recipient (обов’язково) String (13) - gln отримувача family (обов’язково) String (13) - сервіс (сімейство); допустимі значення:
created_from (опціонально) String - ідентифікатор документа або ланцюжка created_from_doc_id (опціонально) String - ідентифікатор документа-підстави (документа, на основі якого буде створено новий) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передається документ у форматі JSON (XML специфікації EDI документів + XML специфікації ETTN документів). Приклад тіла запиту для створення CONDRA. |
RESPONSE
В тілі відповіді в текстовому вигляді передається doc_uuid - унікальний ідентифікатор документа:
e64a304b-b0c0-454b-a361-5dc5d6987952
Отримання UUID (для CONDRA)
GET /api/office/uuid
За допомогою GET методу /api/office/uuid генерується один UUID. Для створення CONDRA потрібно запускати метод двічі.
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/office/uuid |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді в текстовому вигляді передається uuid - сгенерований унікальний ідентифікатор:
c48f97e9-8d98-4c52-8635-675a6145f570
Підписання файлу (для CONDRA)
POST /api/eds/doc/body
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/eds/doc/body?body_type=content&content_type=hash_sign&doc_uuid=37c753a5-7746-4e3f-8485-332c16b63f83&gln=9864067620417&family=edi |
|
URL параметри |
gln (обов’язково) рядок (13) - номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні аккаунта АБО guid (обов’язково) String - унікальний ідентифікатор організації на платформі EDIN 2.0 doc_uuid (обов’язково) UUID - ідентифікатор документа family (опціонально) int - сервіс (сімейство); допустимі значення:
content_type (обов’язково) String – тип тіла контента; можливі значення: hash_sign (константа) body_type (обов’язково) String - тип тіла документа; можливі значення:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
text/plain |
|
REQUEST |
|
|
Body |
В тілі запиту методу передається p7s файл підпису в бінарному вигляді. |
RESPONSE
Код сервера 200 (ok).
Відхилити «Універсальний/неструктурований документ» (CONDRA). Створення квитанції №13
PATCH /api/v2/eds/condra/reject
Відхилити можливо лише вхідний документ, за яким ще не відбувалось Підтвердження / Відхилення / Відкликання!
REQUEST
|
URL |
|
|
Метод запиту |
PATCH |
|
URL запиту |
/api/v2/eds/condra/reject?message=Просто так&gln=9864065732211&doc_uuid=8baa765f-2a4b-4f40-b425-1d00373843c1 |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі; doc_uuid (обов’язково) UUID - ідентифікатор документа message (обов’язково) String - причина відхилення документа |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/xml |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передається тіло документа в xml форматі (специфікація документа CONDRA). |
RESPONSE
В тілі відповіді передаються дані створеної квитанції документа (об’єкт XTicket ).
Відкликати «Універсальний/неструктурований документ» (CONDRA). Створення квитанції №14
PATCH /api/v2/eds/condra/withdraw
Відкликати можливо лише надісланий документ, за яким ще не відбувалось Підтвердження / Відхилення / Відкликання!
REQUEST
|
URL |
|
|
Метод запиту |
PATCH |
|
URL запиту |
/api/v2/eds/condra/withdraw?gln=9864065732181&doc_uuid=3e1525b8-e0a1-49eb-9c8d-2e0597137bdb |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі; doc_uuid (обов’язково) UUID - ідентифікатор документа |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передається тіло документа в xml форматі (специфікація документа CONDRA). |
RESPONSE
В тілі відповіді передаються дані створеної квитанції документа (об’єкт XTicket).
Прийняти «Універсальний/неструктурований документ» (CONDRA)
PATCH /api/v2/eds/condra/confirm/send
Підтвердити можливо лише вхідний документ, за яким ще не відбувалось Підтвердження / Відхилення / Відкликання!
|
URL |
|
|
Метод запиту |
PATCH |
|
URL запиту |
/api/v2/eds/condra/confirm/send?gln=9864065732211&doc_uuid=4b5faf20-db85-41e3-a7cf-10885fc57ef0 |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі; doc_uuid - рядок; UUID документа |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передається тіло документа в xml форматі (специфікація документа CONDRA). |
RESPONSE
Код сервера 200 (ok).
No comments to display
No comments to display