API

 

Hintergrund

Mit der Verfügbarkeits-API können verschiedene Funktionen der Online Services gesteuert werden. Die API wird nach und nach ausgebaut.

Zum Start steht eine Schnittstelle zur Verfügung, über die man sich für Alarme der letzten 3 Minuten zurückmelden kann, etwa für die Integration in die Produkte von www.rueckmelder.de oder aber auch für die Integration in ein beliebiges Smart Home System, welches Webhooks / URL-Aufrufe durchführen kann.

Freischaltung & Aktivierung

Benötigte aPager PRO Versionen

iOS: 1.15.1+

Android: 5.6.0.90+

Lizenzierung

Für die Nutzung der API-Funktionalität ist ein Smart Home Abonnement erforderlich. Dieses können Sie an folgenden Stellen erwerben:

iOS: Einstellungen → Smart Home → “Webhooks”

Android: Einstellungen → IFTTT & Webhooks → “Smart Home-Paket” erwerben oder über das Seitenmenü

Generierung des Zugriffsschlüssels (API Key)

Wechseln Sie in die Verfügbarkeitsverwaltung

  • Android: Seitenmenü “Verfügbarkeit”

  • iOS: Reiter “Verfügbarkeit” in der Navigationsleiste

Wählen Sie bei Doppelmitgliedschaften das korrekte Profil für das Sie die API-Funktionen nutzen möchten, siehe Hinweistext weiter unten.

Dort angekommen öffnen Sie bitte über das Zahnradsymbol oben rechts die Einstellungen der Verfügbarkeit.

Scrollen Sie ans Ende der Seite, hier finden Sie die Optionen für den “Externen Zugriff”

Wenn noch kein Zugriffsschlüssel generiert wurde, so generieren Sie bitte einen über “Neu generieren”

Kopieren Sie dann denn Schlüssel und senden ihn sich bspw. per Mail oder Google Notizen.

Wenn im Nachgang von API Key gesprochen wird, so ist der hier generierte Schlüssel gemeint.

Geben Sie diesen Schlüssel nie an Dritte weiter. Sollte der Schlüssel an Dritte gelangt sein, so sollten Sie aus Sicherheitsgründen einen neuen Schlüssel generieren.

Der generierte Schlüssel kann nur genutzt werden für Aktionen innerhalb des Profils für das er generiert wurde. Wurde für das Profil Feuerwehr Musterhausen ein Schlüssel generiert so können damit bspw. nur Alarme aus exakt diesem System zugesagt werden. Erhält man aus einem anderen Profil, z.B. Rettungsdienst Musterdorf Alarme, so kann für diese mit dem Schlüssel aus Profil Feuerwehr Musterhausen keine Rückmeldung gegeben werden. Der Schlüssel ist also nicht geeignet für Doppelmitgliedschaften sondern immer nur ein Profil.

Nutzt man den Schlüssel z.B. mit Produkten von rueckmelder.de so benötigt man für jede Mitgliedschaft (Profil) ein eigenständiges Gerät.

API-Funktionen

Alarmrückmeldung

Kategorie

URL

Query Parameter

Return Codes

Beispiel

Kategorie

URL

Query Parameter

Return Codes

Beispiel

Alarmrückmeldung
Für einen oder mehrere Alarm(e) der letzten 3 Minuten zurückmelden

https://alamos-backend.ey.r.appspot.com/fe2/feedback/user/external

Erforderlich

authToken:
Der oben generierte API Key (Zugriffsschlüssel)

mode:

Mögliche Werte

  • accept → Teilnahme am Einsatz → “Komme” drücken

  • reject → Teilnahme am Einsatz ablehnen → “Komme nicht” → “Komme nicht / Nein” drücken

Optional

suppressNotification:

  • true → Keine Push-Notification senden die über erfolgreiche Rückmeldung informiert

  • false oder nicht angegeben → Push-Notification erhalten, die über Status der erfolgreichen Rückmeldungen informiert

  • 200 - OK

    • Rückmeldung für mind 1 Alarm

  • 204 - No Content

    • Es wurde kein Alarm gefunden für den eine Rückmeldung abgesetzt werden kann → Nach Wartezeit erneut probieren

  • 403 - API Key falsch

  • 409 - Smart Home Abonnement nicht abgeschlossen / Keine Lizenz

  • 400 Erforderliche Parameter fehlen (authToken und / oder mode)

content-type für Fehlermeldungen:

text/plain;charset=utf-8

https://alamos-backend.ey.r.appspot.com/fe2/feedback/user/external?authToken=meinGeheimerApiKey&mode=accept

Dieser Aufruf würde für den API Key “meinGeheimerApiKey” eine Zusage für die empfangenen Alarme der letzten 3 Minuten durchführen.

Für eine Absage wäre mode=accept zu ersetzen durch mode=reject

 

Beispiel mit unterdrückter Push-Notification (siehe Spalte Query Parameter)

https://alamos-backend.ey.r.appspot.com/fe2/feedback/user/external?authToken=meinGeheimerApiKey&mode=accept&suppressNotification=true