MGBI bietet eine umfassende API zum Abruf von Daten aus öffentlichen Registern und Verzeichnissen, darunter aus dem System zur Bereitstellung von Daten über öffentliche Hilfen (SUDOP). Eine Liste der in diesem Dienst verfügbaren Datenquellen findest du auf der Seite:
👉Öffentliche Register API
Dieser Leitfaden bezieht sich auf die API für das System zur Bereitstellung von Daten über öffentliche Sozialleistungen (SUDOP), die wir im Rahmen des Produkts
zur Verfügung stellen 👉API des Systems zur Bereitstellung von Daten über öffentliche Sozialleistungen (SUDOP API)
Im Folgenden beschreiben wir, wie du über die API Datensätze mit Informationen zu einzelnen Hilfsfällen abrufen kannst, die ein Begünstigter erhalten hat, basierend auf Registrierungsnummern und anderen Parametern.
Schritt 1: Beziehen Sie einen Autorisierungsschlüssel über die API
Um den Autorisierungsschlüssel zu erhalten, der für den Aufruf der in der MGBI-API verfügbaren Endpunkte erforderlich ist, kontaktieren Sie uns bitte über das Kontaktformular auf der Produktseite:
👉API zur Bereitstellung von Daten über öffentliche Hilfen (SUDOP-API)
Schritt 2: Rufe den Endpunkt „Get Records“ auf
Die in SUDOP verfügbaren Daten stellen wir in der MGBI-API im Datenmodell mit der Kennung„pl-sudop-wpopb-record“ bereit.
Die API stellt für dieses Modell den Endpunkt„Get Records“ bereit, der Datensätze mit Informationen zu einzelnen Sozialhilfefällen aus SUDOP zurückgibt, die den angegebenen Kriterien entsprechen.
👉Dokumentation zum Endpunkt „Get Records“ für das Modell „pl-sudop-wpopb-record“
Um Datensätze mit einer Liste der Beihilfen abzurufen, die ein bestimmtes Unternehmen erhalten hat, muss im Endpunkt„Get Records“dessen Registrierungsnummer angegeben werden: KRS, NIP oder REGON.
Beispiel für den Aufruf des Endpunkts „Get Records“ mit der Steuernummer:
GET /v1/models/pl-sudop-wpopb-record/records?identifiers.pl_nip=[Steuernummer] HTTP/1.1
Host: api.mgbi.pl
Authorization: [Autorisierungsschlüssel]Schritt 3: Entnehmen Sie der Antwort die Informationen über die vom Begünstigten erhaltene Unterstützung
Ein korrekter Aufruf des Endpunkts„Get Records“liefert als Antwort alle Informationen zu den Sozialleistungen, die der betreffende Empfänger erhalten hat.
{
"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]"
}
]
}Alle Daten zu einem einzelnen Fall staatlicher Beihilfen, der im SUDOP für das angegebene Unternehmen veröffentlicht wurde, findest du im Verzeichnis„content.raw_result“.
Beispiel für den Inhalt des Wörterbuchs „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]"
}Weitere Informationen:
👉Datenstruktur des Modells „pl-sudop-wpopb-record“
👉Dokumentation der Endpunkte für das Modell „pl-sudop-wpopb-record“
