Toutes les collections
Intégrations
Intégration de l'API web LOQED
Intégration de l'API web LOQED
Mis à jour il y a plus d’une semaine

Avec certaines plateformes ou appareils de maison intelligente, LOQED n'a pas d'intégration directe. Si tu es un utilisateur avancé, tu développes ta propre intégration en utilisant l'API LOQED. Assure-toi de lire notre article "Utilisateurs avancés : Les API disponibles" d'abord.

Lorsque la porte est ouverte/verrouillée, appelle une URL externe (webhook sortant)

Lorsque le statut du verrou est modifié (a atteint cette position) (ouvert, déverrouillé, verrouillé), le backend LOQED peut appeler (POST des données vers) une URL. L'URL que tu veux appeler peut être ajoutée via https://webhooks.loqed.com/ . Les données JSON suivantes sont POSTÉES à cette URL :

  • requested_state (en fait, c'est l'état "arrivé")

    • OUVRIR

    • DAY_LOCK

    • NIGHT_LOCK

    • INCONNU

  • Type d'événement

    • 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 si par ex. ouverture manuelle par le bouton ou en appuyant sur le bouton)

  • nom_clé_utilisateur (null si par ex. ouverture manuelle par le bouton ou en appuyant sur le bouton)

  • nom_clé_admin (null si par ex. ouverture manuelle par le bouton ou en appuyant sur le bouton)

  • key_account_e-mail (null si par ex. ouverture manuelle par bouton ou en appuyant sur un bouton ou si le code PIN d'une clé qui n'est pas liée à un compte)

  • key_account_name (null si par ex. ouverture manuelle par bouton ou en appuyant sur un bouton ou si le code PIN d'une clé qui n'est pas liée à un compte)

Comme tous les systèmes ne prennent pas en charge JSON, il est également possible, par exemple, d'appeler une URL pour l'ouverture et une URL pour le verrouillage (évidemment, la variable requested_state est alors toujours la même).

Aller dans un état

Tu peux aussi demander un webhook lorsque le verrou se rend à une nouvelle position (il pourrait ne pas atteindre la position si les piles sont presque vides, par exemple).
Les événements suivants définissent l'attribut go_to_state du webhook avec l'état du verrou.

  • Go_to_state

    • OUVRIR

    • DAY_LOCK

    • NIGHT_LOCK

  • Type d'événement

    • GO_TO_STATE_INSTANTOPEN_OPEN ( Toucher pour ouvrir ) (go_to_state = OPEN)

    • GO_TO_STATE_INSTANTOPEN_LATCH ( Déverrouillage automatique ) (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 si par ex. ouverture manuelle par le bouton ou en appuyant sur le bouton)

  • nom_clé_utilisateur (null si par ex. ouverture manuelle par le bouton ou en appuyant sur le bouton)

  • nom_clé_admin (null si par ex. ouverture manuelle par le bouton ou en appuyant sur le bouton)

  • key_account_e-mail (null si par ex. ouverture manuelle par bouton ou en appuyant sur un bouton ou si le code PIN d'une clé qui n'est pas liée à un compte)

  • key_account_name (null si par ex. ouverture manuelle par bouton ou en appuyant sur un bouton ou si le code PIN d'une clé qui n'est pas liée à un compte)

Webhook de la puissance Bluetooth et Wi-Fi

Toutes les quelques heures, ou lorsque l'écluse ou le pont est alimenté, une mise à jour des niveaux de signal peut être envoyée. Active la coche pour recevoir ces informations.

  • ble_strength (pourcentage - cela fluctue beaucoup, ne t'inquiète pas si c'est faible)

  • wifi_strength (pourcentage)

  • battery_percentage (pourcentage)

  • lock_id (numéro d'identification de ta serrure)

Verrouiller le webhook en ligne

Toutes les quelques heures, ou lorsque l'écluse ou le pont est alimenté, une mise à jour des niveaux de signal peut être envoyée. Active la coche pour recevoir ces informations.

  • en ligne ("1" est envoyé comme valeur)

  • lock_id (numéro d'identification de ta serrure)

Tester

Nous te recommandons d'utiliser Webhook.site si tu veux vérifier que ta serrure intelligente appelle l'URL du Webhook. Tu pourras aussi y voir les données JSON.

Ouvre/verrouille la porte quand quelque chose se passe (webhook entrant)

Si tu veux contrôler ta serrure à partir d'un service ou d'un appareil tiers, tu peux le faire par le biais d'un appel HTTPS GET à une URL de LOQED.

Connexion à la plateforme Webhooks de LOQED

image
  • Ouvre la page https://webhooks.loqed.com dans ton navigateur Internet.

  • Connecte-toi en utilisant ton adresse e-mail et le mot de passe que tu utilises pour te connecter à l'application LOQED.

    • Attention: En te connectant à cette page, tu te déconnecteras de ton application LOQED, tu devras te reconnecter à ton application LOQED après cela.

Créer une clé d'API

image

Sur cette page, tu peux ajouter des webhooks sortants et créer des webhooks entrants.

  • Clique sur "Ajouter une nouvelle clé API".

image
  • Remplis un nom pour faciliter l'identification. Cela peut être ce que tu veux, il n'est pas nécessaire que ce soit le même nom que ta clé.

  • Si tu as plusieurs verrous, tu peux sélectionner le bon verrou dans le menu déroulant juste à côté de "Sélectionner le verrou".

  • Tu peux maintenant appuyer sur "Ajouter une clé API".

image

Tu as maintenant créé la clé API.

Appelle l'API

Actuellement, l'API prend en charge les commandes suivantes :

  • Ouvre (la porte s'ouvre). Un objet JSON vide est renvoyé.

  • Le loquet (déverrouillé). Un objet JSON vide est renvoyé.

  • Verrouillage de nuit (verrouillé). Un objet JSON vide est renvoyé.

  • Statut. ATTENTION : ne demande le statut qu'une fois par jour. Si tu demandes le statut plus de 12 fois, tu seras bloqué pendant 12 heures. Au lieu de demander l'état, tu devrais mettre en place un webhook qui appelle ton serveur, afin de recevoir une notification instantanée dès que l'état du verrou change. Il renvoie les clés JSON suivantes :

    • id (identification de la serrure)

    • bridge_online (1 si le pont est en ligne, sinon 0)

    • lock_online (1 si le verrou est en ligne, sinon 0)

    • battery_percentage (-1 si le verrou est hors ligne, sinon 0 - 100)

    • battery_type (0 = Alcaline, 1 = NiMH, 2 = Lithium (non rechargeable), 3 = inconnu)

    • bolt_state_numeric (0 = inconnu, 1 = ouvert, 2 = day_lock, 3 = night_lock)

    • État_du_boulon (inconnu, ouvert, day_lock, night_lock)

    • guest_access_mode (1 si activé, 0 si désactivé)

    • twist_assist (1 si activé, 0 si désactivé)

    • touch_to_connect (1 si la restriction de 500 mètres de Touch to Open est supprimée, 0 sinon)

Laisse le serveur LOQED générer la signature numérique

Les commandes envoyées à la serrure intelligente doivent être signées numériquement. Le plus simple est de laisser le serveur LOQED générer cette signature. Il suffit d'utiliser les quatre URL fournies (ouvert, verrouillé, verrouillé la nuit, état) affichées sur webhooks.loqed.com. Si tu préfères toutefois garder ta clé de chiffrement pour toi et ne pas l'envoyer au serveur LOQED, tu peux aussi générer la signature numérique toi-même.

Génère toi-même la signature numérique

Sur https://app.loqed.com/Backend-API-example/ nous fournissons un exemple de code (Javascript et PHP) qui montre comment la signature numérique est créée.

Avez-vous trouvé la réponse à votre question ?