Dieser Abschnitt richtet sich an Entwickler und Integratoren. Für den normalen Betrieb der DoorLine Key ist er nicht erforderlich.
Für eigene Anwendungen und individuelle Anbindungen bietet die Key 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:
-
REST-API: Anmeldung und Sitzungsverwaltung, Geräteinformationen, Protokollabruf als CSV, Neustart, Firmwarestatus sowie den Status des Tastenfelds mit Fehlversuchen, Sperre und Relais-Zuständen.
-
Geräte-API und WebSocket: Endpunkte zum Abfragen von Status- und Sensorwerten (zum Beispiel Zustand des Schalteingangs, Schaltzustand der Relais, WLAN-Signalstärke, Laufzeit) sowie zum Auslösen von Steuerkommandos — Relais schalten, Relais für eine bestimmte Dauer einschalten, Tastenbeleuchtung umschalten und einen Piepton ausgeben. Über WebSocket lassen sich Ereignisse in Echtzeit empfangen, darunter die Keypad-Ereignisse der externen Code-Auswertung und Zustandswechsel des Schalteingangs.
-
Test-Endpunkt: Ziffern lassen sich in die echte Code-Pipeline einspeisen. Die Eingabe durchläuft dieselbe Prüfung wie am Gerät, einschließlich Aktionen und Protokolleintrag.
-
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 — entweder über ein Sitzungs-Cookie aus der Anmeldung oder über das Passwort als Parameter in der Adresse. Der Parameter trägt in der eingebauten Referenz den technischen Namen pin; einzutragen ist das Konfigurations-Passwort.
Über die Geräte-API lassen sich die Relais schalten und damit die Tür öffnen. Der Zugang zur API ist deshalb genauso zu schützen wie die Weboberfläche. Wird das Passwort als Parameter in der Adresse übergeben, erscheint es im Klartext in Protokollen, Browserverläufen und im Netzwerkverkehr, sofern nicht HTTPS verwendet wird. Weitere Hinweise: „Sicherheitshinweise für Integrationen".