MGBI надає комплексний API для отримання даних із державних реєстрів та облікових баз, зокрема з Національного судового реєстру (KRS). Перелік джерел даних, доступних у цій службі, можна знайти на сайті:
👉 Державні реєстри API
Цей посібник стосується API для Репозиторію фінансових документів KRS, який ми надаємо в рамках продукту:
👉 API Національного судового реєстру (KRS API) — Репозиторій фінансових документів
Нижче ми описали, як за допомогою API завантажити файл із змістом фінансового документа зазначеного суб’єкта з Реєстру господарських суб’єктів (KRS) на підставі його номера KRS та інших параметрів.
Крок 1: Отримати ключ авторизації в API
Щоб отримати ключ авторизації, необхідний для виклику ендпоінтів, доступних в MGBI API, зв’яжіться з нами за допомогою контактної форми на сторінці продукту:
👉 API Національного судового реєстру (KRS API) — Репозиторій фінансових документів
Крок 2: Викличте кінцеву точку Get Records
Дані, доступні в Репозиторії фінансових документів KRS, ми надаємо в MGBI API у вигляді моделі даних з ідентифікатором pl-krs-rdf-record.
API надає для цієї моделі кінцеву точку Get Records, яка повертає записи, що містять інформацію про окремі фінансові документи, які відповідають заданим критеріям.
👉 Документація кінцевої точки Get Records для моделі pl-krs-rdf-record
Щоб завантажити перелік документів, доступних у Репозиторії фінансових документів KRS для обраного суб’єкта, необхідно вказати в кінцевій точці Get Records його реєстраційний номер: KRS, NIP або REGON.
Приклад виклику ендпойнту Get Records із номером KRS:
GET /v1/models/pl-krs-rdf-record/records?identifiers.pl_krs=[номер KRS] HTTP/1.1
Host: api.mgbi.pl
Authorization: [ключ авторизації]
Щоб звузити список до документів, які вас цікавлять, ви також можете скористатися додатковими параметрами, такими як:
- type — тип документа (наприклад, річний фінансовий звіт, звіт правління про діяльність суб’єкта господарювання),
- period_major_year — рік, на який припадає більша частина періоду, що охоплюється документом.
У наведеному нижче прикладі для пошуку фінансового звіту за 2025 рік для суб’єкта господарювання із вказаним номером KRS було використано ендпойнт Get Records.
Приклад виклику ендпойнту Get Records із номером KRS, типом документа та фінансовим роком:
GET /v1/models/pl-krs-rdf-record/records?identifiers.pl_krs=[номер KRS]&type=financial_statement._major_year=2025 HTTP/1.1
Host: api.mgbi.pl
Authorization: [ключ авторизації]
Крок 3: Знайдіть у відповіді адресу для завантаження файлу документа
При правильному виклику кінцевої точки Get Records у відповідь повертається список документів, що відповідають заданим критеріям.
У попередніх прикладах кінцева точка повинна повернути список результатів, що містить один або кілька записів:
{
"count": [liczba wyników],
"pages": [liczba stron wyników],
"results": [
{
"id": [identyfikator rekordu],
"identifiers": [identyfikatory podmiotu],
"document": [informacje o dokumencie]
"content": [zawartość dokumentu],
"files": [pliki z treścią dokumentu],
"meta": [metadane rekordu]
}
]
}
Адресу файлу з текстом документа в оригінальному форматі, в якому документ було подано до Репозиторію фінансових документів KRS, можна знайти в полі files.main_document.original.url.
Крок 4: Завантажте вміст файлу та збережіть його або надішліть до браузера
Щоб завантажити вміст файлу з актуальною версією, надішліть запит HTTP GET із адресою, зчитаною з поля files.main_document.original.url, та ключем авторизації в API:
GET [адреса файлу] HTTP/1.1
Host: api.mgbi.pl
Authorization: [ключ авторизації]
Ви також можете відразу надіслати вміст файлу до веб-браузера користувача вашого додатка. У цьому випадку встановіть значення заголовка HTTP Content-Type, яке повідомляє браузеру про формат переданого файлу на основі вмісту поля files.main_document.original.content_type.
Дізнайтеся більше:
👉 Структура даних у моделі pl-krs-rdf-record
👉 Документація щодо кінцевих точок для моделі pl-krs-rdf-record
