Reverse Control API

Autorisierung

Die Autorisierung ist eine HTTP-Basisauthentifizierung. Legen Sie den Autorisierungs-Header als base64(Benutzername:Passwort) fest. Der Port ist auf 9028 konfiguriert.

Zurzeit wurde die Reverse Control in folgendem Umfang implementiert:

Immix
– Auslösen des Reconeyez-Sirenentons

Sentinel
– Auslösen des Reconeyez-Sirenentons
– Scharf-/Unscharfschalten von Reconeyez-Geräten

EBÜS
– Auslösen des Reconeyez-Sirenentons
– Scharf-/Unscharfschalten von Reconeyez-Geräten

Liste der unterstützten Befehle

Sirenen-Liste abrufen

Befehl:

curl -u username:password https://demo.reconeyez.com:9028/control/v1/get_siren_list

Antwort:

• StatusOK 200:

[{"guid":"01AD2DD41C0000C1","name":"New device: 2DAD","area":"WINDOW TEST","description":"","type":"siren_v1"},{"guid":"01E211D51A00006B",

"name":"Siren: 11E2","area":"Office_guard","description":"","type":"siren_v1"}]

• StatusUnauthorized 401: "Unauthorized" – Benutzerdaten ungültig oder Gerätesteuerung nicht erlaubt
• StatusTooManyRequests 429: "Too Many Requests" – mehr als 3 gleichzeitige Anfragen
• StatusInternalServerError 500: "Internal Server Error" – interner Server-Bearbeitungsfehler

Geräteliste abrufen

Befehl:

curl -u username:password https://demo.reconeyez.com:9028/control/v1/get_device_list

curl -u username:password https://demo.reconeyez.com:9028/control/v1/get_device_list/{id}

Antwort:

• StatusOK 200:

[{"guid":"01B3B2931800004D","name":"New device: B2B3","area":"Area name","description":"","type":"siren_v1"},{"guid":"01BBB99318000008","name"

:"New device: B9BB","area":"Test","description":"","type":"detector_hdr"},{"guid":"016BAAC918000080","name":"Dev test device: AA6B","area":"Test",

"description":"","type":"detector_hdr_xrl"},{"guid":"019D28EA19000096","name":"New device: 289D","area":"Kalev Test","description":"","type":"detecto

r_hdr_xrl"},{"guid":"01D3B4441A000042","name":"New device: B4D3","area":"Test","description":"","type":"bridge_4g"}]

• StatusUnauthorized 401: "Unauthorized" – Benutzerdaten ungültig oder Gerätesteuerung nicht erlaubt
• StatusTooManyRequests 429: "Too Many Requests" – mehr als 3 gleichzeitige Anfragen
• StatusInternalServerError 500: "Internal Server Error" – interner Server-Bearbeitungsfehler

Sirene aktivieren

Befehl:

curl -u username:password --request POST https://demo.reconeyez.com:9028/control/v1/play_siren/{id}<?duration=10>

dabei gilt:

{id} ist ein Pflichtfeld (und ist entweder das Reconeyez-Gerät GUID 01AD2DD41C0000C1 oder die Konto-ID wie im Reconeyez-Beschreibungsfeld

angegeben

<?duration=10> ist optional; falls nicht angegeben oder ausgelassen, wird die Standardeinstellung der Reconeyez UI verwendet.

Der Sirenenaufruf wird blockiert.

Antwort:

• StatusOK 200: "Siren playing"
• StatusUnauthorized 401: "Unauthorized" – Benutzerdaten ungültig oder Gerätesteuerung nicht erlaubt
• StatusNotFound 404: "Siren not found" – keine Sirene mit dieser ID
• StatusNotFound 404: "Siren not started" – minimales Abspielintervall nicht übermittelt
• StatusRequestTimeout 408: "Timeout" – 30 Sekunden keine Antwort vom Gerät
• StatusTooManyRequests 429: "Too Many Requests" – mehr als 3 gleichzeitige Anfragen
• StatusInternalServerError 500: "Internal Server Error" – interner Server-Bearbeitungsfehler

Scharf-/Unscharfstellen

Befehl:

curl -u username:password --request POST https://demo.reconeyez.com:9028/control/v1/arm/{id}

curl -u username:password --request POST https://demo.reconeyez.com:9028/control/v1/disarm/{id}

dabei gilt:

{id} ist ein Pflichtfeld (und ist entweder das Reconeyez-Gerät GUID 01AD2DD41C0000C1 oder die Konto-ID wie im Reconeyez-Beschreibungsfeld

angegeben

Das Scharf-/Unscharfstellen wird blockiert.

Antwort:

• StatusOK 200: "Device state changed"
• StatusUnauthorized 401: "Unauthorized" – Benutzerdaten ungültig oder Gerätesteuerung nicht erlaubt
• StatusRequestTimeout 408: "Timeout" – 30 Sekunden keine Antwort vom Gerät
• StatusTooManyRequests 429: "Too Many Requests" – mehr als 3 gleichzeitige Anfragen
• StatusInternalServerError 500: "Internal Server Error" – Interner Server-Bearbeitungsfehler