API сервісу Вільний

Перелік методів API сервісу Вільний

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

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

Робота з документами

Створити документ з метаданими (чернетку)

 POST /api/sd/eds/doc

Отримати документ

 GET /api/sd/eds/doc

Редагувати метадані документа (чернетка)

 PATCH /api/sd/eds/doc

Видалити документ (чернетку)

 DELETE /api/sd/eds/doc

Відхилити вхідний документ

 POST /api/sd/eds/doc/decline

Завантажити документ (zip-архів)

 GET /api/sd/eds/doc/zip

Отримати метадані документа

 GET /api/sd/eds/doc/body

Відправити документ (чернетку)

 PATCH /api/sd/eds/doc/send

Відмітити документа, як «важливий» / «звичайний»

 PATCH /api/sd/eds/doc/important

Отримати список документів

 POST /api/sd/eds/docs/search

Додати отримувача до відправленого документа

 PATCH /api/sd/eds/doc/send/recipients
Робота з файлами (вкладення до документа)

Додати файл до документа-чернетки

 POST /api/sd/eds/doc/attachment

Отримати файл-вкладення

 GET /api/sd/eds/doc/attachment

Видалити файл-вкладення (чернетка)

 DELETE /api/sd/eds/doc/attachment
Підписання
Підписати документ POST /api/sd/eds/doc/sign
Отримати дані про підписання файлу-вкладення GET /api/sd/eds/doc/sign
Створення та відправка документа (без створення чернетки) POST /api/sd/eds/doc/create_and_send
Робота з довідниками

Отримання даних контрагента за ім’ям / ІПН / email / ЄДРПОУ / номером телефону

 GET /api/oas/v2/employees/search
Контрагенти
Додати в сервіс дані нового контрагента / Редагувати дані контрагента POST/api/oas/partner
Отримати дані контрагента (розділ «Контрагенти») GET /api/oas/partner
Завантажити в сервіс список контрагентів з Excel POST /api/oas/partners
Отримати список контрагентів (розділ «Контрагенти») GET /api/oas/partners
Відправити запрошення контрагентам POST /api/eds/doc/statuses
Робота з тегами
Створити новий тег POST /api/sd/eds/employee/tags
Отримати теги GET /api/sd/eds/employee/tags
Редагувати тег PUT /api/sd/eds/employee/tags
Видалити тег DELETE /api/sd/eds/employee/tags
Додати теги до документа POST /api/sd/eds/doc/tags
Вилучити теги з документа DELETE /api/sd/eds/doc/tags

Помилки при роботі з API

Загальні помилки при роботі з API (для всіх сервісів EDIN) можна подивитись за посиланням.

Вилучити теги з документа DELETE /api/sd/eds/doc/tags

REQUEST

URL

  

Метод запиту

DELETE

URL запиту

/api/sd/eds/doc/tags

URL параметри

employee_uuid (обов’язково) UUID - унікальний ідентифікатор користувача

doc_uuid (обов’язково) UUID - ідентифікатор документа

Headers

  

Authorization

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

Content-Type

application/json

REQUEST

  

JSON Body

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

RESPONSE

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

Додати теги до документа POST /api/sd/eds/doc/tags

REQUEST

URL

  

Метод запиту

POST

URL запиту

/api/sd/eds/doc/tags

URL параметри

employee_uuid (обов’язково) UUID - унікальний ідентифікатор користувача

doc_uuid (обов’язково) UUID - ідентифікатор документа

Headers

  

Authorization

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

Content-Type

application/json

REQUEST

  

JSON Body

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

RESPONSE

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

Видалити тег DELETE /api/sd/eds/employee/tags

REQUEST

URL

  

Метод запиту

DELETE

URL запиту

/api/sd/eds/employee/tags

URL параметри

employee_uuid (обов’язково) UUID - унікальний ідентифікатор користувача

Headers

  

Authorization

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

Content-Type

application/json

REQUEST

  

JSON Body

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

 

Приклад запиту:

 

[2, 10, 12]

RESPONSE

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

Редагувати тег PUT /api/sd/eds/employee/tags

Назва тегу повинна бути унікальною й довжиною не більше 20 символів.

REQUEST

URL

  

Метод запиту

PUT

URL запиту

/api/sd/eds/employee/tags

URL параметри

employee_uuid (обов’язково) UUID - унікальний ідентифікатор користувача

Headers

  

Authorization

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

Content-Type

application/json

REQUEST

  

JSON Body

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

RESPONSE

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

Отримати теги GET /api/sd/eds/employee/tags

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/sd/eds/employee/tags

URL параметри

employee_uuid (обов’язково) UUID - унікальний ідентифікатор користувача

search (опціонально) String - пошук за назвою тега

Headers

  

Authorization

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

Content-Type

application/json

RESPONSE

В тілі відповіді (json) передається список (масив) тегів.

Створити новий тег POST /api/sd/eds/employee/tags

Назва тегу повинна бути унікальною й довжиною не більше 20 символів.

REQUEST

URL

  

Метод запиту

POST

URL запиту

/api/sd/eds/employee/tags

URL параметри

employee_uuid (обов’язково) UUID - унікальний ідентифікатор користувача

Headers

  

Authorization

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

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту (json) передається список назв тегів у вигляді масиву рядків.

 

Приклад запиту:

 

["Ken", "json", "Stethem"]

RESPONSE

В тілі відповіді (json) передається масив створених тегів.

Отримати список контрагентів (розділ «Контрагенти») GET /api/oas/partners

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/oas/partners

URL параметри

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

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

pattern (опціонально) String - пошукове значення (фільтр по даним контрагентів);

registration_status (опціонально) int - статус реєстрації; 0 - незарестрований, 1 - зареєстрований;

invitation_status (опціонально) int - статус запрошення; 0 - запрошення не відправлено, 1 - запрошення відправлено

Headers

  

Authorization

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

Content-Type

application/json

RESPONSE

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

Завантажити в сервіс список контрагентів з Excel POST /api/oas/partners

REQUEST

URL

  

Метод запиту

POST

URL запиту

/api/oas/partners

Headers

  

Authorization

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

Content-Type

application/json

REQUEST

  

JSON Body

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

RESPONSE

В тілі відповіді (json) передаються завантажені в сервіс контрагенти та контрагенти з помилковими даними (потребують правок).

Отримати дані контрагента (розділ «Контрагенти») GET /api/oas/partner

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/oas/partner

URL параметри

partner_id int(10) - id контрагента

Headers

  

Authorization

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

Content-Type

application/json

RESPONSE

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

Додати в сервіс дані нового контрагента / Редагувати дані контрагента POST/api/oas/partner

Вибір дії (додавання або редагування): якщо в тілі запиту (json) присутній ідентифікатор контрагента (параметр id), то такий контрагент підлягає редагуванню (дані оновляться). Відсутність в запиті параметра id веде до створення (додавання в сервіс) нового контрагента.

REQUEST

URL

  

Метод запиту

POST

URL запиту

/api/oas/partner

Headers

  

Authorization

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

Content-Type

application/json

REQUEST

  

JSON Body

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

RESPONSE

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

Отримання даних контрагента за ім’ям / ІПН / email / ЄДРПОУ / номером телефону GET /api/oas/v2/employees/search

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/oas/v2/employees/search

URL параметри

query (обов’язково) String - текст пошуку (ім’я / ІПН / email / ЄДРПОУ / номер телефону)

by_company (опціонально) int - фільтр пошуку:

  • 0 - пошук серед контрагентів компанії;

  • 1 - пошук серед контрагентів компанії і її співробітників

by_alias (опціонально) int - фільтр пошуку:

  • 0 - пошук контрагентів без аліасів;

  • 1 - пошук контрагентів включаючи аліаси

Headers

  

Authorization

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

Content-Type

application/json

RESPONSE

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

Створення та відправка документа (без створення чернетки) POST /api/sd/eds/doc/create_and_send

REQUEST

URL

  

Метод запиту

POST

URL запиту

/api/sd/eds/doc/create_and_send

Headers

  

Authorization

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

Content-Type

multipart/form-data

REQUEST

  

JSON Body

В тілі запиту методу обов’язково передаються два файли (+ додатково можуть передаватись підписи):

  • Тіло документа - json файл, що містить дані про отримувачів, тему документа, повідомлення. Назва файлу повинна бути з префіксом _doc_body_, наприклад: _doc_body_vilniy-doc.json. Детальніше: Метадані документа;

  • Файли для відправки - не більше 10 файлів в наступних форматах: PDF/JPG/JPEG/PNG/BMP/DOC/DOCX/XLS/XLSX/PPT/PPTX/CSV/TXT/XML/P7S з розміром файлу не більше 5 Мб. Назви файлів повинні бути з префіксом _doc_file_, наприклад: _doc_file_dogovir.txt;

  • Підписи - підписи до файлів (опціонально). Назви файлів підписів повинні бути з префіксом _doc_sign_file_name, де file_name - це назва файлу, до якого відноситься підпис, наприклад: _doc_sign_dogovir.txt1.p7s та _doc_sign_dogovir.txt2.p7s.

RESPONSE

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

Отримати дані про підписання файлу-вкладення GET /api/sd/eds/doc/sign

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/sd/eds/doc/sign

URL параметри

attachment_uuid (обов’язково) UUID - ідентифікатор файла-вкладення;

employee_uuid (опціонально) UUID - ідентифікатор співробітника, під яким виконуються обробка документа

Headers

  

Authorization

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

Content-Type

application/json

RESPONSE

В тілі відповіді (json) передається список uuid-ів Відправника і Отримувачів документа з масивами даних про підписи для кожного uuid відповідно.

Підписати документ POST /api/sd/eds/doc/sign

Для підписання документ повинен містити файл/файли.

REQUEST

URL

  

Метод запиту

POST

URL запиту

/api/sd/eds/doc/sign

URL параметри

doc_uuid (обов’язково) UUID - ідентифікатор документа;

employee_uuid (опціонально) UUID - ідентифікатор співробітника, під яким виконується обробка документа;

Headers

  

Authorization

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

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту (json) передається список uuid-ів вкладених файлів з масивом підписів (BASE64) для підписання цих файлів.

 

Приклад запиту:

 

{
  "6616bce2-2b48-4f24-b636-652c3da0a853": [
    "MIIORwYJK...yBXJjg="
  ],
  "5152f5d1-e1e4-4a60-be5c-b8118d93d594": [
    "MIIOR...I0lU="
  ]
}

RESPONSE

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

Видалити файл-вкладення (чернетка) DELETE /api/sd/eds/doc/attachment

REQUEST

URL

  

Метод запиту

DELETE

URL запиту

/api/sd/eds/doc/attachment

URL параметри

attachment_uuid (обов’язково) UUID - ідентифікатор файла-вкладення

employee_uuid (опціонально) UUID - ідентифікатор співробітника, під яким виконується обробка документа

Headers

  

Authorization

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

Content-Type

application/json

RESPONSE

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

Отримати файл-вкладення GET /api/sd/eds/doc/attachment

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/sd/eds/doc/attachment

URL параметри

attachment_uuid (обов’язково) UUID - ідентифікатор файла-вкладення;

employee_uuid (опціонально) UUID - ідентифікатор співробітника, під яким виконується обробка документа

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

  • bytes - файл передається в бінарному вигляді;

  • file - відповідь передається у вигляді файла з розширенням;

  • base64 - файл в форматі Base64;

  • pdf - файл в форматі pdf;

  • zip - архів, який містить файл;

  • print - прінт-форма файла

Headers

  

Authorization

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

Content-Type

application/json

RESPONSE

В тілі відповіді передається файл-вкладення.

Додати файл до документа-чернетки POST /api/sd/eds/doc/attachment

Один документ може містити не більше 10 файлів в наступних форматах: PDF/JPG/JPEG/PNG/BMP/DOC/DOCX/XLS/XLSX/PPT/PPTX/CSV/TXT/XML/P7S (попередній перегляд працює лише для PDF/JPG/JPEG/PNG/BMP/TXT/XML) з розміром файлу не більше 5 Мб. Назва файла не повинна перевищувати 100 символів.

REQUEST

URL

  

Метод запиту

POST

URL запиту

/api/sd/eds/doc/attachment

URL параметри

doc_uuid (обов’язково) UUID - ідентифікатор документа

employee_uuid (опціонально) UUID - ідентифікатор співробітника, під яким виконуються обробка документа

Headers

  

Authorization

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

Content-Type

multipart/form-data

REQUEST

  

Form-data

В тілі запиту передається 1 файл.

 

Приклад запиту:

 

boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW

----WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="222"; filename="1613574143975.png"
Content-Type: image/png

(data)
----WebKitFormBoundary7MA4YWxkTrZu0gW

RESPONSE

В тілі відповіді (json) передаються дані файла-вкладення (об'єкт XDocAttachment).

Додати отримувача до відправленого документа PATCH /api/sd/eds/doc/send/recipients

Лише Відправник документа має можливість додавати нових контрагентів. Додавання отримувачів до вже відправленого документа можливо поки документ (оригінал) знаходиться в статусі Очікує підпису / Підписано частково (детальніше про статуси документів).

REQUEST

URL

  

Метод запиту

PATCH

URL запиту

/api/sd/eds/doc/send/recipients

URL параметри

doc_uuid (обов’язково) UUID - ідентифікатор документа

Headers

  

Authorization

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

REQUEST

  

JSON Body

В тілі запиту (json) передається:

  • масив UUID користувачів (нових отримувачів): ['92e62300-74bd-43e8-9db7-48481cd5bbbc']

АБО

  • масив e-mail адрес для незареєстрованих на платформі EDIN користувачів: ['fff@lll.com','ukr@ukr.ukr']

RESPONSE

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

Отримати список документів POST /api/sd/eds/docs/search

REQUEST

URL

  

Метод запиту

POST

URL запиту

/api/sd/eds/docs/search

URL параметри

employee_uuid (опціонально) UUID - ідентифікатор співробітника, під яким виконується обробка документа

Headers

  

Authorization

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

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту (json) передаються дані для фільтрації (об’єкт StorageQuery)

RESPONSE

В тілі відповіді (json) передається масив з відібраними документами.

Відмітити документ, як «важливий» / «звичайний» PATCH /api/sd/eds/doc/important

REQUEST

URL

  

Метод запиту

PATCH

URL запиту

/api/sd/eds/doc/important

URL параметри

doc_uuid (обов’язково) UUID - ідентифікатор документа;

employee_uuid (опціонально) UUID - ідентифікатор співробітника, під яким виконуються обробка документа;

important (обов’язково) boolean:

  • true - відмітити документ, як важливий

  • false - відмітити документ, як звичайний

Headers

  

Authorization

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

Content-Type

application/json

RESPONSE

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

Відправити документ (чернетку) PATCH /api/sd/eds/doc/send

REQUEST

URL

  

Метод запиту

PATCH

URL запиту

/api/sd/eds/doc/send

URL параметри

doc_uuid (обов’язково) UUID - ідентифікатор документа

Headers

  

Authorization

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

Content-Type

application/json

RESPONSE

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

Отримати метадані документа GET /api/sd/eds/doc/body

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/sd/eds/doc/body

URL параметри

doc_uuid (обов’язково) UUID - ідентифікатор документа;

employee_uuid (опціонально) UUID - ідентифікатор співробітника, під яким виконуються обробка документа;

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

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

  • file

  • base64

Headers

  

Authorization

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

Content-Type

application/json

RESPONSE

В тілі відповіді (json) передаються метадані документа.

Завантажити документ (zip-архів) GET /api/sd/eds/doc/zip

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/sd/eds/doc/zip

URL параметри

doc_uuid (обов’язково) UUID - ідентифікатор документа

employee_uuid (опціонально) UUID - ідентифікатор співробітника, під яким виконується обробка документа

Headers

  

Authorization

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

Content-Type

application/json

RESPONSE

В тілі відповіді передається документ (zip-архів). Детальніше про завантаження.

Відхилити вхідний документ POST /api/sd/eds/doc/decline

REQUEST

URL

  

Метод запиту

POST

URL запиту

/api/sd/eds/doc/decline

URL параметри

doc_uuid (обов’язково) UUID - ідентифікатор документа

Headers

  

Authorization

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

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту передається текст причини відхилення.

 

Приклад тіла запиту:

 

Невірно складений договір, орфографічні помилки

RESPONSE

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

Видалити документ (чернетку) DELETE /api/sd/eds/doc

REQUEST

URL

  

Метод запиту

DELETE

URL запиту

/api/sd/eds/doc

URL параметри

doc_uuid (обов’язково) UUID - ідентифікатор документа

employee_uuid (опціонально) UUID - ідентифікатор співробітника, під яким виконуються обробка документа

Headers

  

Authorization

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

Content-Type

application/json

RESPONSE

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

Редагувати метадані документа (чернетка) PATCH /api/sd/eds/doc

REQUEST

URL

  

Метод запиту

PATCH

URL запиту

/api/sd/eds/doc

URL параметри

doc_uuid (обов’язково) UUID - ідентифікатор документа

employee_uuid (опціонально) UUID - ідентифікатор співробітника, під яким виконуються обробка документа

Headers

  

Authorization

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

Content-Type

multipart/form-data

REQUEST

  

JSON Body

В тілі запиту передається json файл з метаданими документа

 

 Приклад запиту:

 

boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW

----WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="file"; filename="acceptance.json"
Content-Type: application/json

{"receivers":["831714cf-064b-4ce9-bdc4-b6a79784639c"],"title":"rock&roll123","text":"text povidomlennya"}
----WebKitFormBoundary7MA4YWxkTrZu0gW

RESPONSE

В тілі відповіді (json) передається doc_uuid - унікальний ідентифікатор документа:

{"doc_uuid":"023403f8-9201-41f2-8c18-cf4777a058fc"}

Отримати документ GET /api/sd/eds/doc

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/sd/eds/doc

URL параметри

doc_uuid (обов’язково) UUID - ідентифікатор документа

employee_uuid (опціонально) UUID - ідентифікатор співробітника, під яким виконуються обробка документа

Headers

  

Authorization

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

Content-Type

application/json

RESPONSE

В тілі відповіді (json) передаються дані документа (об'єкт XDoc).

Створити документ з метаданими (чернетку) POST /api/sd/eds/doc

REQUEST

URL

  

Метод запиту

POST

URL запиту

/api/sd/eds/doc

Headers

  

Authorization

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

Content-Type

multipart/form-data

REQUEST

  

JSON Body

В тілі запиту передається json файл з метаданими документа

 

Приклад запиту:

 

boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW

----WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="file"; filename="acceptance.json"
Content-Type: application/json

{"receivers":["831714cf-064b-4ce9-bdc4-b6a79784639c"],"title":"rock&roll123","text":"text povidomlennya"}
----WebKitFormBoundary7MA4YWxkTrZu0gW

RESPONSE

В тілі відповіді (json) передається doc_uuid - унікальний ідентифікатор документа:

{"doc_uuid":"023403f8-9201-41f2-8c18-cf4777a058fc"}