API Dokumentation

NINA API Dokumentation

Die NINA API bietet Zugriff auf Daten des NINA-Warnsystems, die über verschiedene Endpunkte abgerufen werden können. Über den GET-Parameter endpoint können unterschiedliche Datensätze abgefragt werden, wie z. B. Dashboard-Daten, Warnungen oder Logos. Die Basis-URL lautet:
https://nina.api.proxy.bund.de/api31/

Hinweis: Für den Zugriff auf diese API ist ein gültiger API-Key erforderlich. Ein API-Key für den Zugang ist auf Anfrage erhältlich.

Authentifizierung

Jeder API-Aufruf muss den Parameter api_key enthalten. Wird der API-Key nicht mitgegeben oder ist er ungültig, erfolgt die Rückgabe einer Fehlermeldung.

?api_key=DEIN_API_KEY

Parameter und Endpunkte

Neben dem API-Key muss über den Parameter endpoint der gewünschte Endpunkt angegeben werden. Erlaubte Endpunkte umfassen:

• dashboard: Liefert Übersichts- und Statusdaten des Warnsystems. Hier ist zusätzlich der Parameter region erforderlich, um die Daten für eine bestimmte Region abzurufen.
  Beispiel: ?endpoint=dashboard&region=BW
• warnings: Gibt spezifische Warnmeldungen zurück. Hier muss der Parameter identifier angegeben werden. Falls das Ausgabeformat nicht automatisch anhängt, wird dies ergänzt.
  Beispiel: ?endpoint=warnings&identifier=101.de
• gsb_logos: Liefert Logo-Daten im JSON-Format, die beispielsweise für die grafische Darstellung in Apps genutzt werden.
  Beispiel: ?endpoint=gsb_logos

Weitere Parameter

Optional können weitere Parameter übergeben werden, z. B.:

• region: Erforderlich beim Endpunkt dashboard.
• identifier: Erforderlich beim Endpunkt warnings.
• format: Legt das gewünschte Ausgabeformat fest. Unterstützte Formate sind json (Standard), xml, csv und jsonp.
• callback: Erforderlich, wenn als Ausgabeformat jsonp gewählt wird.

Ausgabeformate

Standardmäßig liefert die NINA API Daten im JSON-Format. Über den Parameter format kann das Ausgabeformat geändert werden:

• json (Standard): ?format=json
• xml: ?format=xml
• csv: ?format=csv
• jsonp: ?format=jsonp&callback=DEIN_CALLBACK

Beispielaufrufe

Beispielaufruf für Dashboard-Daten:

https://api.ix23.de/nina/?api_key=DEIN_API_KEY&endpoint=dashboard&region=BW&format=json

Beispielaufruf für Warnmeldungen:

https://api.ix23.de/nina/?api_key=DEIN_API_KEY&endpoint=warnings&identifier=101.de&format=json

Beispielaufruf für Logo-Daten:

https://api.ix23.de/nina/?api_key=DEIN_API_KEY&endpoint=gsb_logos&format=json

Fehlerbehandlung

Bei fehlerhaften oder unvollständigen Parametern gibt die API eine entsprechende Fehlermeldung zurück. Beispiele:

{
  "error": "API key missing (API-Schlüssel fehlt)"
}

{
  "error": "No endpoint specified (Kein Endpunkt angegeben)"
}

{
  "error": "Invalid endpoint specified (Ungültiger Endpunkt)"
}