MGBI dostarcza kompleksowe API do pobierania danych z rejestrów i ewidencji publicznych, w tym z Rejestrów Działalności Regulowanej (RDR).
Listę źródeł danych dostępnych w tej usłudze znajdziesz na stronie:
👉 Rejestry Publiczne API
Ten poradnik dotyczy API dla Rejestrów Działalności Regulowanej (RDR) dla podmiotów zarejestrowanych w Krajowym Rejestrze Sądowym (KRS), który udostępniamy w ramach produktu:
👉 Rejestry Działalności Regulowanej API (RDR API)
Poniżej opisaliśmy, w jaki sposób możesz pobrać przez API treść wpisów RDR dla wskazanych podmiotów na podstawie ich numerów rejestrowych (KRS, NIP lub REGON).
Krok 1: Uzyskaj klucz autoryzacji w API
Aby zdobyć klucz autoryzacji wymagany przy wywoływaniu endpointów dostępnych w MGBI API, skontaktuj się z nami przy użyciu formularza kontaktowego na stronie produktu:
👉 Rejestry Działalności Regulowanej API (RDR API)
Krok 2: Wywołaj endpoint Create Refresh
Dane dostępne w RDR udostępniamy w MGBI API w modelu danych o identyfikatorze pl-rdr-record.
Model ten jest synchronizowany na żądanie, co oznacza, że nie dysponujemy dla niego w naszych zbiorach pełną kopią danych dostępnych w rejestrze źródłowym.
Aby uzyskać z modelu aktualne dane dotyczące wskazanego podmiotu, musisz najpierw utworzyć zlecenie ich pobrania z RDR przy użyciu endpointu Create Refresh.
👉 Dokumentacja endpointu Create Refresh
Przykład wywołania endpointu Create Refresh z numerem KRS:
POST /v1/refresh HTTP/1.1
Host: api.mgbi.pl
Authorization: [klucz autoryzacji]
{
"query": {
"model": "pl-rdr-record",
"identifiers.pl_krs": "[numer KRS]"
}
}Prawidłowe wywołanie endpointu Create Refresh zwraca w odpowiedzi słownik zawierający identyfikator zlecenia w polu id.
Krok 3: Wywołaj endpoint Get Refresh
Zlecenia pobrania danych z rejestru źródłowego zwykle trwają od kilku do kilkunastu sekund od momentu ich utworzenia endpointem Create Refresh.
Aby sprawdzić aktualny status zlecenia, wywołaj endpoint Get Refresh podając w adresie URL jego identyfikator uzyskany w poprzednim kroku.
👉 Dokumentacja endpointu Get Refresh
Przykład wywołania endpointu Get Refresh z identyfikatorem zlecenia:
GET /v1/refresh/[identyfikator zlecenia] HTTP/1.1
Host: api.mgbi.pl
Authorization: [klucz autoryzacji]Jeśli w zwróconym słowniku pole status przyjmuje wartość pending, zlecenie jest jeszcze w trakcie wykonywania i należy ponownie wywołać endpoint Get Refresh za kilka sekund.
Jeśli pole status przyjmuje wartość success, to oznacza, że zlecenie zostało wykonane i dane dotyczące wskazanego dłużnika zostały już pobrane z rejestru źródłowego.
Krok 4: Wywołaj endpoint Get Records
API dla modelu pl-rdr-record udostępnia endpoint Get Records, który zwraca rekordy z pełną treścią odpowiedzi z rejestru RDR dla wskazanego numeru KRS.
👉 Dokumentacja endpointu Get Records dla modelu pl-rdr-record
Aby otrzymać dane pobrane z rejestru źródłowego w utworzonym wcześniej zleceniu, wywołaj endpoint Get Records przekazując identyfikator zlecenia w parametrze refresh_id.
GET /v1/models/pl-rdr-record/records?refresh_id=[identyfikator zlecenia] HTTP/1.1
Host: api.mgbi.pl
Authorization: [klucz autoryzacji]Krok 5: Odczytaj z odpowiedzi listę koncesji, zezwoleń i wpisów do RDR dla wskazanego podmiotu
Prawidłowe wywołanie endpointu Get Records zwraca w odpowiedzi listę rekordów spełniających podane kryteria.
W powyższym przykładzie endpoint powinien zwrócić listę wyników zawierającą jeden rekord:
{
"count": 1,
"pages": 1,
"results": [
{
"id": "[identyfikator rekordu]",
"identifiers": "[identyfikatory podmiotu]",
"content": "[treść odpowiedzi]",
"meta": "[metadane rekordu]"
}
]
}Wszystkie dane o pojedynczych uprawnieniach dostępne w RDR dla wskazanego podmiotu możesz znaleźć w elementach listy content.raw_result.permissions.
Przykładowa zawartość elementu listy 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]"
}Uzyskaj więcej informacji:
👉 Struktura danych w modelu pl-rdr-record
👉 Dokumentacja endpointów dla modelu pl-rdr-record
