API-Schnittstelle

WARNUNG

Geben Sie Ihren persönlichen API-Key niemals an Dritte weiter.

API-Schnittstelle aktivieren

Nachfolgend wird Ihnen erklärt, wie Sie die EMS-API-Schnittstelle für Ihre Alarmierung aktivieren können.

Schritt-für-Schritt Anleitung

1. Öffnen Sie in den Einstellungen der EMS-Verwaltung den Menüpunkt Alarm-Eingang API.
2. Aktivieren Sie den Schalter Alarm-API aktivieren.
3. Die EMS-API ist nun aktiviert und einsatzbereit.

API-Schnittstelle auslösen

Nachfolgend wird Ihnen erklärt, wie Sie die API-Schnittstelle ansprechen können und somit einen Alarm auslösen können.

API-Attribute:

Attribut	Datentyp	Beschreibung
apiKey	String	API-Schlüssel zur Authentifizierung
serial	String	Einsatznummer
datatime	String	Zeitstempel des Ereignisses
alertingKeyword	String	Schlüsselwort für die Alarmmeldung
alertingKeywordText	String	Textbeschreibung des Alarm-Schlüsselworts
alertingKeywordAddOn	String	Zusätzliche Informationen zum Schlüsselwort
alertingKeywordExtension	String	Erweiterung des Schlüsselworts für spezifische Bedingungen
text	String	Beschreibung des Einsatzes
objectName	String	Name des Objekts/Standorts
objectPlan	String	Plan- oder Projektnummer des Objekts
street	String	Straße, in der sich das Objekt befindet
houseNumber	String	Hausnummer des Objekts
city	String	Stadt, in der sich das Objekt befindet
cityDistrict	String	Stadtteil des Objekts
address	String	Vollständige Adresse des Objekts
lat	String	Breitengrad des Standorts
lon	String	Längengrad des Standorts
units	String	Eingesetzte Einheiten oder Mannschaften
emergencyServices	String	EMS Meldeschleifenbezeichnungen
vehicle	String	Fahrzeugrufname der eingesetzten Fahrzeuge
stations	String	Namen der Wachen
rics	String	RICS-Nummern der Funkgeräte
winddirectionName	String	Windrichtung in Namen z.B. North, East, South, West
winddirectionDegree	String	Windrichtung in Grad
windspeed	String	Windgeschwindigkeit in km/h
windgusts	String	Böenwindgeschwindigkeit in km/h
weatherTime	String	Zeitpunkt der Wetterdaten
caller	String	Name des Anrufers
callerInfo	String	Zusätzliche Informationen über den Anrufer
specialInfo	String	Besondere Informationen oder Hinweise
status	String	Legen Sie den Einsatzstatus fest 1=aktiv, 2=beendet. Die Zuordnung läuft über den Parameter serial

Schritt-für-Schritt Anleitung

Die Alarm-API kann über verschiedene Software-Tools angesprochen werden. Im folgenden Beispiel wird das kostenlose Tool Postman verwendet:

1. Laden und installieren Sie Postman: Download Postman.
2. Erstellen Sie in Postman einen neuen POST-Request.
3. Geben Sie die folgende POST-URL ein:

https://einsatzmeldesystem.de/ems/inbound/deployment/universal/

4. Öffnen Sie im Request den Bereich Body, stellen Sie das Format auf RAW und wählen Sie JSON aus.
5. Fügen Sie den folgenden Beispielcode ein und tragen Sie Ihren persönlichen API-Key ein:

Tipp

Nur das Attribut "apiKey" ist ein Pflichtfeld für den Empfang über die Alarm-API. Alle anderen Felder sind optional.

Hinweis für den Einsatzstatus

Für das Datenfeld Status können folgende Werte eingesetzt werden:

1 = Einsatz aktiv

2 = Einsatz beendet

{
 "apiKey": "HIER API KEY EINFÜGEN",
 "serial": "EMS-112",
 "datetime": "YYYY-MM-DD HH:MM:SS",
 "alertingKeyword": "TH",
 "alertingKeywordText": "Technische Hilfeleistung",
 "alertingKeywordAddOn": "Türöffnung",
 "alertingKeywordExtension": "Hochhaus",
 "text": "Verschlossene Tür",
 "objectName": "Waldkindergarten Regenbogen",
 "objectPlan": "0815",
 "street": "Poststraße",
 "houseNumber": "1a",
 "city": "Musterhausen",
 "cityDistrict": "Musterhausen Feld",
 "address": "Poststraße 1a, 23060 Musterhausen",
 "lat": "52.440468",
 "lon": "9.442648",
 "units": "FF Musterdorf; FF Musterhausen",
 "emergencyServices": "KBM Musterkreis; WF Musterhausen",
 "vehicle": "12/44/7 ELW 1; 12/42/7 HLF 20",
 "stations": "Wache Nord; Wache Süd",
 "rics": "1258745; 2587456",
 "winddirectionName": "Nord",
 "winddirectionDegree": "180",
 "windspeed": "20",
 "windgusts": "25",
 "weatherTime": "2025-02-26 17:14:39",
 "caller": "Max Mustermann",
 "callerInfo": "Bewohner",
 "specialInfo": "Sonderinformation 1;ohne Sondersignal#Sonderinfo 2;über Poststraße 3 anfahren",
 "status": "1"
}

6. Wenn alle Datenfelder Ihren Wünschen entsprechend angepasst wurden und der API-Key hinterlegt ist, klicken Sie auf Send, um den Alarm über die EMS-API auszulösen.