fwMAX.de Hilfe

API und Schnittstelle

Zuletzt aktualisiert:

Wozu

fwMAX.de hat eine offene REST-API unter https://api.fwmax.de/v1. Damit holt ihr Daten in eigene Systeme oder schickt Einsätze aus Alamos FE2 und der Leitstelle direkt hinein. Die vollständige Beschreibung steht unter Schnittstelle.

Schritt für Schritt

  1. Schlüssel anlegen. Verwaltung › Schnittstelle: API-Schlüssel anlegen. Er wird nur einmal angezeigt; sperren und löschen geht jederzeit.
  2. Anfragen senden. Header Authorization: Bearer fwmax_…, z. B. GET /v1/personen?suche= oder GET /v1/fristen?tage=60.
  3. Einsätze empfangen. FE2 sendet an POST /v1/einsaetze/fe2; andere Systeme an POST /v1/einsaetze.

So läuft es ab

Datenfluss über die Schnittstelle
Datenfluss über die SchnittstelleLeitstelle, Alamos FE2 und eigene Systeme sprechen mit api.fwmax.de. Der API-Schlüssel bestimmt die Feuerwehr und die Rechte. Fehlt ein gültiger Schlüssel oder das Recht, antwortet die API mit 401 oder 403, sonst mit JSON. Über Webhooks meldet fwMAX.de Ereignisse zurück.

POST /v1/einsaetze/fe2

Bearer-Schlüssel

nein

ja

Webhooks

Leitstelle / Alamos FE2

api.fwmax.de

Eigenes System

Schlüssel gültig,
Recht vorhanden?

401 / 403

Daten eurer Feuerwehr

JSON-Antwort

Kurz erklärt: Leitstelle, Alamos FE2 und eigene Systeme sprechen mit api.fwmax.de. Der API-Schlüssel bestimmt die Feuerwehr und die Rechte. Fehlt ein gültiger Schlüssel oder das Recht, antwortet die API mit 401 oder 403, sonst mit JSON. Über Webhooks meldet fwMAX.de Ereignisse zurück.

Rollen und Rechte

  • API-Schlüssel verwalten: Recht „API-Schnittstelle“.
  • Einsätze anlegen per API: „Einsätze bearbeiten“.

Tipps

  • Zum Ausprobieren gibt es einen Demo-Schlüssel, siehe Schnittstelle.
  • Gebt jedem System einen eigenen Schlüssel, dann könnt ihr ihn einzeln sperren.

Häufige Fragen

Gibt es Kosten für die API?

Nein, die Schnittstelle ist im Preis enthalten.

Wo finde ich die Endpunkte?

Auf der Seite Schnittstelle und in der interaktiven Beschreibung unter api.fwmax.de.

Verwandte Themen

Fehlt etwas? Im Programm oben rechts „Problem melden oder Verbesserung vorschlagen“, oder per E-Mail an support@fwmax.de.