- Allgemeines
- API Schlüssel
- Authentifizierung von API Requests
- Basis-URL der API
- Swagger Dokumentation
Allgemeines
In diesem Artikel zeigen wir dir, wie du die Löschmeister REST-API verwenden kannst, um den Zugriff auf unsere Plattform zu automatisieren. Die API wird laufend um neue Funktionen erweitert.
API-Schlüssel
Um auf die Löschmeister API zuzugreifen, musst du zuerst in der Web App einen API-Schlüssel für deine Feuerwehr erstellen. Der Schlüssel ist immer an die Feuerwehr gebunden und kann nur von jemandem mit einer Leiter-Rolle verwaltet werden.
Navigiere dazu in der Web App auf die Feuerwehrdetails und wechsle in den Tab Bearbeiten (ganz rechts oder Klick auf den Bearbeiten Button). Scrolle anschließend nach unten zum Bereich Öffentliche API.
Hier kannst du einen API-Schlüssel erstellen, löschen oder neu erstellen (überschreibt einen bereits bestehenden Schlüssel).
Der API-Schlüssel wird nur einmalig bei der Erstellung angezeigt und muss an einem sicheren Ort gespeichert werden.
Sollte der API-Schlüssel verloren gehen oder in falsche Hände geraten, kann er jederzeit gelöscht oder neu erstellt werden.
Authentifizierung von API Requests
Der API-Schlüssel muss bei jedem Request im Header
X-KM-ORG-API-KEY gesetzt werden.
Basis-URL der API
Die base-url der Löschmeister API ist: https://rest.loeschmeister.app
Swagger Dokumentation
Die Swagger Dokumentation der Löschmeister API findest du unter folgenden Links:
-
Swagger Dokumentation dargestellt in Viewer:
https://redocly.github.io/redoc/?url=https://rest.loeschmeister.app/v3/api-docs/m2m -
Swagger JSON zur eigenen Verwendung:
https://rest.loeschmeister.app/v3/api-docs/m2m