Alle Kollektionen
Integration
LOQED Web API Integration
LOQED Web API Integration
Vor über einer Woche aktualisiert

Mit einigen Smart Home-Plattformen oder -Geräten hat LOQED keine direkte Integration. Wenn du ein fortgeschrittener Benutzer bist, entwickelst du deine eigene Integration, indem du die LOQED-API nutzt. Lies unbedingt unseren Artikel "Fortgeschrittene Benutzer: Verfügbare APIs" zuerst.

Wenn die Tür geöffnet/verschlossen wird, rufe eine externe URL auf (ausgehender Webhook)

Wenn sich der Status des Schlosses ändert (diese Position erreicht) (offen, entsperrt, verriegelt), kann das LOQED-Backend eine URL aufrufen (POST-Daten an). Die URL, die du aufrufen willst, kannst du über https://webhooks.loqed.com/ hinzufügen. Die folgenden JSON-Daten werden an diese URL gepostet:

  • requested_state (eigentlich ist dies der "angekommene" Zustand)

    • ÖFFNEN

    • DAY_LOCK

    • NIGHT_LOCK

    • UNBEKANNT

  • event_type

    • STATE_CHANGED_OPEN (requested_state = OPEN)

    • STATE_CHANGED_LATCH (requested_state = DAY_LOCK)

    • STATE_CHANGED_NIGHT_LOCK (requested_state = NIGHT_LOCK)

    • STATE_CHANGED_UNKNOWN (requested_state = UNKNOWN)

    • MOTOR_STALL (requested_state = UNKNOWN)

  • lock_id

  • key_local_id (null, wenn z.B. Manuelles Öffnen durch Knopf oder Drücken des Knopfes)

  • key_name_user (null, wenn z.B. Manuelles Öffnen durch Knopf oder Drücken des Knopfes)

  • key_name_admin (null, wenn z.B. Manuelles Öffnen durch Knopf oder Drücken des Knopfes)

  • key_account_e-mail (null, wenn z.B. manuelle Öffnung durch Knopfdruck oder PIN eines Schlüssels, der nicht an ein Konto gebunden ist)

  • key_account_name (null, wenn z.B. manuelle Öffnung durch Knopfdruck oder PIN eines Schlüssels, der nicht an ein Konto gebunden ist)

Da nicht alle Systeme JSON unterstützen, ist es auch möglich, z. B. eine URL zum Öffnen und eine URL zum Sperren aufzurufen (natürlich ist die Variable requested_state dann immer gleich).

Zu einem Staat gehen

Du kannst auch einen Webhook anfordern, wenn das Schloss zu einer neuen Position geht (es könnte die Position nicht erreichen, wenn z.B. die Batterien fast leer sind).
Die folgenden Ereignisse setzen das Webhook-Attribut go_to_state mit dem Zustand des Schlosses.

  • go_to_state

    • ÖFFNEN

    • DAY_LOCK

    • NIGHT_LOCK

  • event_type

    • GO_TO_STATE_INSTANTOPEN_OPEN ( Touch to Open ) (go_to_state = OPEN)

    • GO_TO_STATE_INSTANTOPEN_LATCH ( Auto Unlock ) (go_to_state = DAY_LOCK)

    • GO_TO_STATE_MANUAL_UNLOCK_BLE_OPEN (go_to_state = OPEN)

    • GO_TO_STATE_MANUAL_LOCK_BLE_LATCH (go_to_state = DAY_LOCK)

    • GO_TO_STATE_MANUAL_LOCK_BLE_NIGHT_LOCK (go_to_state = NIGHT_LOCK)

    • GO_TO_STATE_TWIST_ASSIST_OPEN (go_to_state = OPEN)

    • GO_TO_STATE_TWIST_ASSIST_LATCH (go_to_state = DAY_LOCK)

    • GO_TO_STATE_TWIST_ASSIST_LOCK (go_to_state = NIGHT_LOCK)

    • GO_TO_STATE_MANUAL_UNLOCK_VIA_OUTSIDE_MODULE_PIN (go_to_state = OPEN)

    • GO_TO_STATE_MANUAL_UNLOCK_VIA_OUTSIDE_MODULE_BUTTON (go_to_state = OPEN)

    • GO_TO_STATE_TOUCH_TO_LOCK (go_to_state = NIGHT_LOCK)

    • GO_TO_STATE_MANUAL_UNLOCK_REMOTE_OPEN

    • GO_TO_STATE_MANUAL_LOCK_REMOTE_LATCH

    • GO_TO_STATE_MANUAL_LOCK_REMOTE_NIGHT_LOCK

  • lock_id

  • key_local_id (null, wenn z.B. Manuelles Öffnen durch Knopf oder Drücken des Knopfes)

  • key_name_user (null, wenn z.B. Manuelles Öffnen durch Knopf oder Drücken des Knopfes)

  • key_name_admin (null, wenn z.B. Manuelles Öffnen durch Knopf oder Drücken des Knopfes)

  • key_account_e-mail (null, wenn z.B. manuelle Öffnung durch Knopfdruck oder PIN eines Schlüssels, der nicht an ein Konto gebunden ist)

  • key_account_name (null, wenn z.B. manuelle Öffnung durch Knopfdruck oder PIN eines Schlüssels, der nicht an ein Konto gebunden ist)

Bluetooth und Wi-Fi Stärke Webhook

Alle paar Stunden oder wenn die Schleuse oder Brücke mit Strom versorgt wird, kann eine Aktualisierung der Signalpegel gesendet werden. Aktiviere das Häkchen, um diese Informationen zu erhalten.

  • ble_strength (Prozentsatz - dieser Wert schwankt stark, mach dir keine Sorgen, wenn er niedrig ist)

  • wifi_strength (Prozent)

  • battery_percentage (Prozentsatz)

  • lock_id (Identifikationsnummer deines Schlosses)

Online-Webhaken sperren

Alle paar Stunden oder wenn die Schleuse oder Brücke mit Strom versorgt wird, kann eine Aktualisierung der Signalpegel gesendet werden. Aktiviere das Häkchen, um diese Informationen zu erhalten.

  • online ("1" wird als Wert gesendet)

  • lock_id (Identifikationsnummer deines Schlosses)

Testen

Wir empfehlen, Webhook.site zu verwenden, wenn du überprüfen willst, ob dein Smart Lock die Webhook-URL aufruft. Dort kannst du auch die JSON-Daten sehen.

Öffne/schließe die Tür, wenn etwas passiert (eingehender Webhook)

Wenn du dein Schloss von einem Dienst oder Gerät eines Drittanbieters aus steuern möchtest, kannst du dies über einen HTTPS GET-Aufruf an eine URL von LOQED tun.

Anmeldung bei der LOQED Webhooks-Plattform

Bild
  • Öffne die Seite https://webhooks.loqed.com in deinem Internetbrowser.

  • Melde dich mit deiner E-Mail-Adresse und deinem Passwort an, die du für die Anmeldung in der LOQED-App verwendest.

    • Achtung: Wenn du dich auf dieser Seite einloggst, wirst du von deiner LOQED-App abgemeldet. Du musst dich danach wieder in deine LOQED-App einloggen.

Einen API-Schlüssel erstellen

Bild

Auf dieser Seite kannst du ausgehende Webhooks hinzufügen und eingehende Webhooks erstellen.

  • Klicke auf "Neuen API-Schlüssel hinzufügen".

Bild
  • Gib einen Namen ein, um die Identifizierung zu erleichtern. Das kann ein beliebiger Name sein, er muss nicht mit dem Namen deines Schlüssels übereinstimmen.

  • Wenn du mehrere Schlösser hast, kannst du das richtige Schloss im Dropdown-Menü rechts neben "Schloss auswählen" auswählen.

  • Du kannst jetzt auf "API-Schlüssel hinzufügen" klicken.

Bild

Du hast jetzt den API-Schlüssel erstellt.

Die API aufrufen

Derzeit unterstützt die API die folgenden Befehle:

  • Öffnen (Tür öffnet sich). Es wird ein leeres JSON-Objekt zurückgegeben.

  • Verriegelung (entriegelt). Es wird ein leeres JSON-Objekt zurückgegeben.

  • Nachtsperre (abgeschlossen). Es wird ein leeres JSON-Objekt zurückgegeben.

  • Status. ACHTUNG: Bitte beantrage den Status nur einmal pro Tag. Wenn du den Status mehr als 12 Mal anforderst, wirst du für 12 Stunden gesperrt. Anstatt den Status abzufragen, solltest du einen Webhook implementieren, der deinen Server anruft, damit du eine sofortige Benachrichtigung erhältst, sobald sich der Status der Sperre ändert. Sie gibt die folgenden JSON-Schlüssel zurück:

    • id (Identifikation des Schlosses)

    • bridge_online (1, wenn die Brücke online ist, sonst 0)

    • lock_online (1, wenn die Sperre online ist, sonst 0)

    • battery_percentage (-1 wenn das Schloss offline ist, sonst 0 - 100)

    • battery_type (0 = Alkaline, 1 = NiMH, 2 = Lithium (nicht wiederaufladbar), 3 = unbekannt)

    • bolt_state_numeric (0 = unbekannt, 1 = offen, 2 = day_lock, 3 = night_lock)

    • bolt_state (unknown, open, day_lock, night_lock)

    • guest_access_mode (1 wenn aktiviert, 0 wenn deaktiviert)

    • twist_assist (1 wenn aktiviert, 0 wenn deaktiviert)

    • touch_to_connect (1, wenn die 500-Meter-Beschränkung für Touch to Open aufgehoben ist, sonst 0)

Lass den LOQED-Server die digitale Signatur erstellen

Die Befehle an das Smart Lock müssen digital signiert werden. Am einfachsten ist es, diese Signatur vom LOQED-Server erstellen zu lassen. Verwende einfach die vier bereitgestellten URLs (open, latch, night lock, status), die auf webhooks.loqed.com angezeigt werden. Wenn du deinen Verschlüsselungsschlüssel lieber für dich behältst und ihn nicht an den LOQED-Server sendest, kannst du die digitale Signatur auch selbst erstellen.

Erstelle die digitale Signatur selbst

Unter https://app.loqed.com/Backend-API-example/ stellen wir Beispielcode (Javascript und PHP) bereit, der zeigt, wie die digitale Signatur erstellt wird.

Hat dies Ihre Frage beantwortet?