MGBI надає комплексний API для отримання даних із державних реєстрів та облікових баз, зокрема з Реєстрів регульованої діяльності (RDR).
Перелік джерел даних, доступних у цій службі, можна знайти на сторінці:
👉API публічних реєстрів
Цей посібник стосуєтьсяAPI для Реєстрів регульованої діяльності (RDR) для суб’єктів, зареєстрованих у Національному судовому реєстрі (KRS), який ми надаємо в рамках продукту:
👉API Реєстрів регульованої діяльності (RDR API)
Нижче ми описали, якза допомогою API можназавантажити зміст записів RDR для вказаних суб’єктів на основі їхніх реєстраційних номерів (KRS, NIP або REGON).
Крок 1: Отримати ключ авторизації в API
Щоб отримати ключ авторизації, необхідний для виклику кінцевих точок, доступних в MGBI API, зв’яжіться з нами за допомогою контактної форми на сторінці продукту:
👉API реєстрів регульованої діяльності (RDR API)
Крок 2: Викличте кінцеву точку Create Refresh
Дані, доступні в RDR, ми надаємо в MGBI API у моделі даних з ідентифікаторомpl-rdr-record.
Ця модель синхронізується за запитом, що означає, що в наших базах даних ми не маємо повної копії даних, доступних у вихідному реєстрі.
Щоб отримати з моделі актуальні дані щодо вказаного суб’єкта, спочатку потрібно створити запит на їх завантаження з RDR за допомогою ендпойнтуCreate Refresh.
👉Документація ендпойнту Create Refresh
Приклад виклику ендпойнту Create Refresh із номером KRS:
POST /v1/refresh HTTP/1.1
Host: api.mgbi.pl
Authorization: [klucz autoryzacji]
{
"query": {
"model": "pl-rdr-record",
"identifiers.pl_krs": "[numer KRS]"
}
}
При правильному виклику кінцевої точкиCreate Refreshу відповідь повертається словник, що містить ідентифікатор запиту в поліid.
Крок 3: Викличте кінцеву точку Get Refresh
Запити на отримання даних із вихідного реєстру зазвичай виконуються протягом від кількох до кількох десятків секунд з моменту їх створення кінцевою точкоюCreate Refresh.
Щоб перевірити поточний статус замовлення, викличте ендпоінтGet Refresh, вказавши в URL-адресі його ідентифікатор, отриманий на попередньому кроці.
👉Документація ендпоінту Get Refresh
Приклад виклику кінцевої точки Get Refresh із ідентифікатором запиту:
GET /v1/refresh/[ідентифікатор запиту] HTTP/1.1
Host: api.mgbi.pl
Authorization: [ключ авторизації]
Якщо у повернутому словнику поле status має значенняpending, запит ще виконується, і через кілька секунд слід знову викликати ендпоінтGet Refresh.
Якщо поле «статус» має значення«success», це означає, що запит виконано, а дані щодо вказаного боржника вже отримано з вихідного реєстру.
Крок 4: Викличте кінцеву точку Get Records
API для моделіpl-rdr-recordнадає кінцеву точкуGet Records, яка повертає записи з повним текстом відповіді з реєстру RDR для вказаного номера KRS.
👉Документація кінцевої точки Get Records для моделі pl-rdr-record
Щоб отримати дані, завантажені з вихідного реєстру у створеному раніше запиті, викличте кінцеву точкуGet Records, передавши ідентифікатор запиту в параметріrefresh_id.
GET /v1/models/pl-rdr-record/records?refresh_id=[ідентифікатор запиту] HTTP/1.1
Host: api.mgbi.pl
Authorization: [ключ авторизації]
Крок 5: З’ясуйте з відповіді перелік ліцензій, дозволів та записів у реєстрі RDR для зазначеного суб’єкта господарювання
При правильному виклику кінцевої точки Get Records у відповідь повертається список записів, що відповідають заданим критеріям.
У наведеному вище прикладі кінцева точка повинна повернути список результатів, що містить один запис:
{
"count": 1,
"pages": 1,
"results": [
{
"id": "[identyfikator rekordu]",
"identifiers": "[identyfikatory podmiotu]",
"content": "[treść odpowiedzi]",
"meta": "[metadane rekordu]"
}
]
}
Усі дані про окремі дозволи, доступні в RDR для вказаного суб’єкта, можна знайти в елементах списку content.raw_result.permissions.
Приклад вмісту елемента списку content.raw_result.permissions:
{
"from": "[data początkowa okresu obowiązywania]",
"to": "[data końcowa okresu obowiązywania]",
"name": "[nazwa uprawnienia]",
"description": "[opis uprawnienia]",
"issueAuthorityName": "[nazwa organu wydającego]"
}
Дізнайтеся більше:
👉Структура даних у моделі pl-rdr-record
👉Документація щодо кінцевих точок для моделі pl-rdr-record