DoorLine Cam / Snap modular

REST- und WebSocket-API

Dieser Abschnitt richtet sich an Entwickler und Integratoren. Für den normalen Betrieb der DoorLine Cam / Snap ist er nicht erforderlich.

Für eigene Anwendungen und individuelle Anbindungen bieten Cam und Snap eine dokumentierte REST- und WebSocket-Schnittstelle. Alle Aufrufe erfolgen lokal im Netzwerk.

Die vollständige, jederzeit zur installierten Firmware passende Referenz ist direkt in die Weboberfläche eingebaut. Sie befindet sich auf der Seite „API" und enthält:

  • Kamera-Bildabruf: die Adressen für Einzelbild, Livestream und das Bild der letzten Betätigung der Klingeltaste (/jpg, /stream, /lastbell) — auch in der geschützten Variante mit Kamera-Passwort (?pin=…).

  • Geräte-API und WebSocket: Endpunkte zum Abfragen von Status- und Sensorwerten (zum Beispiel Schalteingang, Schaltzustand der Relais, Helligkeit, WLAN-Signalstärke, Gerätezeit, Laufzeit) sowie zum Auslösen von Steuerkommandos. Über WebSocket lassen sich Ereignisse in Echtzeit empfangen.

  • Maschinenlesbare Spezifikationen zum Herunterladen: die OpenAPI-Spezifikation (REST) und die AsyncAPI-Spezifikation (WebSocket), jeweils passend zur laufenden Firmware.

Endpunkte, die mit einem Schloss-Symbol gekennzeichnet sind, erfordern eine gültige Anmeldung am Gerät. Ausgenommen ist der reine Bildabruf, der zusätzlich über das Kamera-Passwort freigegeben werden kann (siehe Kapitel „5. Betrieb und Wartung → Abrufen des Kamerabildes").