Робота з сертифікатами
Всі запити нижче перерахованих API методів платформи EDIN 2.0 направляються на адресу: https://edo-v2.edin.ua
Для роботи з цими методами користувач повинен бути авторизованим.
Створити сертифікат
POST /api/ecs/certificate
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/ecs/certificate?gln=9864232613879 |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту (json) передається об’єкт з даними сертифіката. |
RESPONSE
У тілі відповіді передається унікальний ідентифікатор (UUID) створеного сертифіката, наприклад: 55ef04b2-281e-4fca-bb67-d48fe88ae74f.
Оновити сертифікат
PUT /api/ecs/certificate
REQUEST
|
URL |
|
|
Метод запиту |
PUT |
|
URL запиту |
/api/ecs/certificate?gln=9864232613879 |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту (json) передається об’єкт з даними сертифіката. |
RESPONSE
Код сервера 200 (ok).
Отримати сертифікат
GET /api/ecs/certificate
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/ecs/certificate?uuid=55ef04b2-281e-4fca-bb67-d48fe88ae74f&gln=9864232613879 |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; uuid (обов’язково) UUID - унікальний ідентифікатор сертифіката |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
RESPONSE
В тілі відповіді передаються дані про сертифікат.
Видалити сертифікат
DELETE /api/ecs/certificate
REQUEST
|
URL |
|
|
Метод запиту |
DELETE |
|
URL запиту |
/api/ecs/certificate?uuid=55ef04b2-281e-4fca-bb67-d48fe88ae74f&gln=9864232613879 |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; uuid (обов’язково) UUID - унікальний ідентифікатор сертифіката |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
RESPONSE
Код сервера 200 (ok).
Архівувати / розархівувати сертифікат
PUT /api/ecs/archive
Дія «архівувати» / «розархівувати» залежить від того, де перебуває сертифікат до виконання метода:
-
якщо сертифікат в Архіві, то виконається розархівування;
-
якщо сертифікат в Опублікованих, то виконається архівування.
REQUEST
|
URL |
|
|
Метод запиту |
PUT |
|
URL запиту |
/api/ecs/archive?gln=9864232613879&uuid=3ff444f4-7594-4a43-a151-90e14ee92b0c |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; uuid (обов’язково) UUID - унікальний ідентифікатор сертифіката |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
RESPONSE
Код сервера 200 (ok).
Задати/змінити тип доступу до сертифіката
PUT /api/ecs/access
REQUEST
|
URL |
|
|
Метод запиту |
PUT |
|
URL запиту |
/api/ecs/access?gln=9864232613879&uuid=3ff444f4-7594-4a43-a151-90e14ee92b0c&uuid=8f56bb6c-b895-42b6-adf2-7a3e4bca7165&type=public |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; uuid (обов’язково) UUID - унікальний ідентифікатор сертифіката (можливо передавати кілька в одному запиті) type (обов’язково) String - тип доступу, можливі значення:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
Тіло очікується лише при type=private: тіло запиту в форматі Map<Long, Boolean>, де ключ - це intGlnID кому відкрито доступ, а значення true/false - чи буде дозволено даному intGlnID репостити цей сертифікат комусь іще.
Приклад тіла запиту:
[[13203393,false],[13203397,false]] |
RESPONSE
Код сервера 200 (ok).
Копіювати сертифікат
PUT /api/ecs/copy
REQUEST
|
URL |
|
|
Метод запиту |
PUT |
|
URL запиту |
/api/ecs/copy?gln=9864232613879&uuid=3ff444f4-7594-4a43-a151-90e14ee92b0c |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; uuid (обов’язково) UUID - унікальний ідентифікатор сертифіката company_id (опціонально) long - ідентифікатор компанії, від якої здійснюється запит |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
Код сервера 200 (ok).
Знайти сертифікат/-ти
POST /api/ecs/search
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/ecs/search?gln=9864232613879 |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії owner_gln (необов’язково) String - GLN Компанії-Власника сертифікату |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передаються дані для фільтрації (об’єкт XQueryCertificates) |
RESPONSE
В тілі відповіді передаються дані про сертифікати.
Додати (прив’язати) товари до сертифіката
PUT /api/ecs/products
Якщо продукт уже прив’язаний до сертифіката і в тілі передано його ідентифікатор (XCertificateProduct.id), то дані товару будуть оновлені, в іншому випадку буде створено новий товар.
REQUEST
|
URL |
|
|
Метод запиту |
PUT |
|
URL запиту |
/api/ecs/products?gln=9864232613879&uuid=3ff444f4-7594-4a43-a151-90e14ee92b0c |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; uuid (обов’язково) UUID - унікальний ідентифікатор сертифіката |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передаються дані товарів, що прив’язуються до сертифіката (масив об’єктів XCertificateProduct). |
RESPONSE
Код сервера 200 (ok).
Масово завантажити сертифікати
POST /api/ecs/certificates
Максимальний розмір файлу для завантаження - 7,5 МБ
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/ecs/certificates?gln=9864232613879 |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
|
|
REQUEST |
|
|
JSON Body |
В тілі запиту передається zip-файл, що містить файли-вкладення (в форматі PDF, JPG, JPEG, PNG, TIFF) та заповнений xls/xlsx шаблон з зазначеними назвами файлів-вкладень. |
Приклад передаваємого zip знаходиться у вкладенні до цієї сторінки (ліва бокова панель).
RESPONSE
У тілі відповіді передаються дані завантажених сертифікатів (масив об’єктів XCertificate).
Якщо в сертифікатах, що передаються, буде допущена помилка, то Ви отримаєте відповідь про помилку в файлі.
Створити сертифікат з типом «Декларація виробника» (CERTDOC)
POST /api/ecs/certdoc
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/ecs/certdoc?gln=9864065732181 |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії publish (необов’язково) Boolean- ознака публікації сертифікату при створенні:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
|
|
REQUEST |
|
|
Form-data |
В тілі запиту передається XML файл сертифіката. |
RESPONSE
У тілі відповіді передається унікальний ідентифікатор (UUID) створеного сертифіката, наприклад:
55ef04b2-281e-4fca-bb67-d48fe88ae74f.
No comments to display
No comments to display