MGBI dostarcza kompleksowe API do pobierania danych z rejestrów i ewidencji publicznych, w tym z Systemu Udostępniania Danych o Pomocy Publicznej (SUDOP). Listę źródeł danych dostępnych w tej usłudze znajdziesz na stronie:
👉 Rejestry Publiczne API
Ten poradnik dotyczy API dla Systemu Udostępniania Danych o Pomocy Publicznej (SUDOP), który udostępniamy w ramach produktu:
👉 System Udostępniania Danych o Pomocy Publicznej API (SUDOP API)
Poniżej opisaliśmy, w jaki sposób możesz pobrać przez API rekordy z informacjami o pojedynczych przypadkach pomocy otrzymanej przez beneficjenta na podstawie numerów rejestrowych oraz innych parametrów.
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:
👉 System Udostępniania Danych o Pomocy Publicznej API (SUDOP API)
Krok 2: Wywołaj endpoint Get Records
Dane dostępne w SUDOP udostępniamy w MGBI API w modelu danych o identyfikatorze pl-sudop-wpopb-record.
API udostępnia dla tego modelu endpoint Get Records, który zwraca rekordy z informacjami o pojedynczych przypadkach pomocy publicznej z SUDOP, spełniające podane kryteria.
👉 Dokumentacja endpointu Get Records dla modelu pl-sudop-wpopb-record
Pobranie rekordów z listą przypadków pomocy jakie otrzymał dany podmiot wymaga podania w endpoincie Get Records jego numeru rejestrowego: KRS, NIP lub REGON.
Przykład wywołania endpointu Get Records z numerem NIP:
GET /v1/models/pl-sudop-wpopb-record/records?identifiers.pl_nip=[numer NIP] HTTP/1.1
Host: api.mgbi.pl
Authorization: [klucz autoryzacji]Krok 3: Odczytaj z odpowiedzi informację o pomocy otrzymanej przez beneficjenta
Prawidłowe wywołanie endpointu Get Records zwraca w odpowiedzi komplet informacji o pomocy publicznej jaką otrzymał dany podmiot.
{
"count": 1,
"pages": 1,
"results": [
{
"id": "[identyfikator rekordu]",
"identifiers": "[identyfikatory podmiotu i powiązanych osób]",
"content": "[informacja o pomocy udzielonej beneficjentowi]",
"meta": "[metadane rekordu]"
}
]
}Wszystkie dane o pojedynczym przypadku pomocy publicznej ujawnionym w SUDOP dla wskazanego podmiotu możesz znaleźć w słowniku content.raw_result.
Przykładowa zawartość słownika content.raw_result:
{
"dni-udzielenia-pomocy": "[dni udzielenia pomocy]",
"forma-pomocy-kod": "[kod formy pomocy]",
"forma-pomocy-nazwa": "[nazwa formy pomocy]",
"gmina-siedziby-kod": "[kod siedziby gminy]",
"gmina-siedziby-nazwa": "[nazwa siedziby gminy]",
"nazwa-beneficjenta": "[nazwa beneficjenta pomocy]",
"nazwa-udzielajacego-pomocy": "[nazwa podmiotu udzielającego pomocy]",
"nip-beneficjenta": "[NIP beneficjenta pomocy]",
"nip-udzielajacego-pomocy": "[NIP podmiotu udzielającego pomocy]",
"podstawa-prawna-2a-kod": "[kod podstawy prawnej 2a]",
"podstawa-prawna-2a-nazwa": "[nazwa podstawy prawnej 2a]",
"podstawa-prawna-2b": "[podstawa prawna 2b]",
"podstawa-prawna-2c": "[podstawa prawna 2c]",
"podstawa-prawna-3a": "[podstawa prawna 3a]",
"podstawa-prawna-3b": "[podstawa prawna 3b]",
"przeznaczenie-pomocy-kod": "[kod przeznaczenia pomocy]",
"przeznaczenie-pomocy-nazwa": "[nazwa przeznaczenia pomocy]",
"sektor-dzialalnosci-kod": "[kod sektora działalności]",
"sektor-dzialalnosci-nazwa": "[nazwa sektora działalności]",
"sektor-dzialalnosci-wersja": "[wersja klasyfikacji sektora działalności]",
"srodek-pomocowy-nazwa": "[nazwa środka pomocowego]",
"symbol-aktu-ogolnego": "[symbol aktu ogólnego]",
"wartosc-brutto-eur": "[wartość brutto pomocy w EUR]",
"wartosc-brutto-pln": "[wartość brutto pomocy w PLN]",
"wartosc-nominalna-pln": "[wartość nominalna pomocy w PLN]",
"wielkosc-beneficjenta-kod": "[kod wielkości beneficjenta]",
"wielkosc-beneficjenta-nazwa": "[nazwa wielkości beneficjenta]"
}Uzyskaj więcej informacji:
👉 Struktura danych w modelu pl-sudop-wpopb-record
👉 Dokumentacja endpointów dla modelu pl-sudop-wpopb-record
