Connect Benutzer API

Die Connect Benutzer API bietet die Möglichkeit API Anfragen nur für den eigenen Benutzer auszuführen. Der Unterschied zur Öffentlichen Connect Schnittstelle ist, dass über die Öffentliche Connect Schnittstelle alle Daten eines Standortes oder einer Organisation abgerufen und geändert werden können. Über die Benutzer API können nur Daten im eigenen User Kontext abgerufen und geädert werden. Die User API kann daher von jedem Connect Benutzer aktiviert werden.

Die vollständige Beschreibung der API ist unter Swagger zu finden. Auf dieser Seite werden lediglich einige Beispiele genauer erklärt.

Aktivierung der User Benutzer API

Melden Sie sich mit Ihrem Benutzer am Connect Portal an und wählen Sie den Menüpunkt „Smart Home“ und anschließend „Benutzer API„.

Klicken Sie auf „Neu“ um einen neuen Authentifizierungsschlüssel zu erzeugen. Geben Sie nun eine Beschreibung für die Verwendung des Zugriffsschlüssel ein und wählen Sie den Verwendungszweck aus.

Sie bekommen den Authentifizierungsschlüssel nun im Connect Portal angezeigt. Sie können den Schlüssel dort jederzeit wieder abrufen.

Verwendungszwecke

Einsatzrückmeldung User-API

Hierüber können Sie Rückmeldung zu einem Einsatz geben. Dies kann aus jedem System erfolgen welches ein HTTP GET Request absetzen kann z.B. aus einer Routine eines Smart Home Systems oder durch den „Rückmelder„, ein smarter Rückmeldebutton für deine Wohnung.

Die Einsatzrückmeldung funktioniert über einen GET Request mit vir Parametern.

Protokoll: Ausschließlich HTTPS

Basisadresse: https://connectapi.feuersoftware.com/interfaces/public/user/userstatus

Parameter Token: Dies ist der Hex-String zur Authentifizierung welchen Sie zuvor im Connect Portal erzeugt haben.

Parameter Status: Hier wird ein String erwartet mit einem der folgenden Werten (coming/notComing/comingLater)

Parameter siteID: Optionaler Parameter. Hier wird die ID des Standortes mitgegeben um nur Einsätze innerhalb eines Standortes zuzusagen.

Parameter driveTimeSeconds: Optionaler Parameter. Anzahl der Sekunden bis zum Eintreffen im Feuerwehrhaus.

Der Aufruf kann nun wie folgt aussehen:

 https://connectapi.feuersoftware.com/interfaces/public/user/userstatus?token=<HEXTOKEN-EINFÜGEN>&status=<STATUS-EINFÜGEN>

Rückantwort:

Return	Beschreibung
HTTP 204 – No Content	Einsatzrückmeldung erfolgreich übermittelt
HTTP 401 – Unauthorized	Token ungültig
HTTP 404 – Not Found	Benutzer zum Token nicht gefunden

Hinweise:

Die Zusage wird für den aktuellsten Einsatz, der für den Nutzer vorhanden ist, der nicht älter als 2h ist, ausgelöst. Falls kein Einsatz mit diesen Kriterien gefunden wurde, wird die Rückmeldung in einen Puffer geschrieben. Sobald der Einsatz dann da ist, werden die bereits vorhandenen Rückmeldungen aus dem Puffer übernommen. (Rückmeldungen innerhalb der letzten 5 Minuten)

Verfügbarkeit User-API

Hierüber können Sie Ihre allgemeine Verfügbarkeit setzen. Dies kann aus jedem System erfolgen welches ein HTTP GET Request absetzen kann z.B. aus einer Routine eines Smart Home Systems..

Die Einsatzrückmeldung funktioniert über einen GET Request mit drei Parametern.

Protokoll: Ausschließlich HTTPS

Basisadresse: https://connectapi.feuersoftware.com/interfaces/public/user/useravailability

Parameter Token: Dies ist der Hex-String zur Authentifizierung welchen Sie zuvor im Connect Portal erzeugt haben.

Parameter Status: Hier wird ein String erwartet mit einem der folgenden Werten (available/limitedAvailable/notAvailable)

Parameter lifeTimeDays: Gibt an für wie viele Tage die Verfügbarkeit gesetzt wird. Nach Ablauf der Zeit wird die Verfügbarkeit automatisch zurück gesetzt.

Der Aufruf kann nun wie folgt aussehen:

https://connectapi.feuersoftware.com/interfaces/public/user/useravailability?token=<HEXTOKEN-EINFÜGEN>&status=<STATUS-EINFÜGEN>&lifeTimeDays=<TAGE-EINFÜGEN>

Return	Beschreibung
HTTP 204 – No Content	Verfügbarkeit erfolgreich übermittelt
HTTP 401 – Unauthorized	Token ungültig
HTTP 404 – Not Found	Benutzer zum Token nicht gefunden