Авторизація

Доступ до всіх сервісів УБКІ здійснюється за наявності чинного сесійного ключа.

 

Для отримання сесійного ключа використовується сервіс авторизації. Ключ діє до 23:59:59 дати, в яку він був отриманий. Новий ключ можна отримати з 22:00, він буде діяти з моменту отримання і весь наступний день. Kлюч може бути скомпрометований і заблокований з різних причин, сервіс поверне повідомлення "Помилка безпеки. Час життя сесійного ключа минув". У такій ситуації слід авторизуватися заново.

Сесійний ключ необхідно отримувати виключно один раз на добу. ВАЖЛИВО не формувати новий сесійний ключ при кожному запиті, так як це створює зайве навантаження в роботі сервісів. Запит на отримання сесійного ключа підтримується у форматах xml/json. Необхідно вказувати HTTP заголовки - Content-Type: application/xml або Content-Type: application/json.

  1. Якщо ваше програмне забезпечення використовує заголовок Content-Type: application/json; charset=utf-8, необхідно додатково вказати HTTP заголовок X-API-Version:2

Сервіс авторизації

Request

Request

JSON

headers:

Content-Type: application/json Accept: application/json

body:

{ "doc" : { "auth" : { "login" : "Логін", "pass" : "Пароль" } } }

XML

headers:

Content-Type: application/xml Accept: application/xml

body:

<!-- Запит необхідно кодувати в Base64 --!>

Response

Response

JSON

body:

XML

body:

 

При виконанні запиту авторизації, у разі некоректного запиту або недостатніх налаштувань облікового запису користувача, API поверне код помилки. Щоб мінімізувати помилки при інтеграції з API та для правильного налаштування відповіді, необхідно аналізувати всі отримані помилки.


Вступ

Отримання інформації із бюро

Передача інформації в бюро

Послуга "Моніторинг суб'єктів"

Тестове середовище

Довідники

Журнал змін