Todas las colecciones
Integraciones
Integración de la API web de LOQED
Integración de la API web de LOQED
Actualizado hace más de una semana

Con algunas plataformas o dispositivos domésticos inteligentes LOQED no tiene integración directa. Si eres un usuario avanzado, puedes desarrollar tu propia integración utilizando la API de LOQED. Asegúrate de leer primero nuestro artículo "Usuarios avanzados: APIs disponibles" primero.

Cuando se abre/cierra la puerta, llama a una URL externa (webhook saliente)

Cuando el estado de la cerradura cambia (alcanza esta posición) (abierta, desbloqueada, bloqueada), el backend LOQED puede llamar (enviar datos POST) a una URL. La URL a la que quieres llamar se puede añadir mediante https://webhooks.loqed.com/ . Los siguientes datos JSON se envían a esta URL:

  • estado_solicitado (en realidad, es el estado "llegado")

    • ABIERTO

    • BLOQUEO_DÍA

    • BLOQUEO NOCTURNO

    • DESCONOCIDO

  • tipo_evento

    • STATE_CHANGED_OPEN (estado_solicitado = OPEN)

    • STATE_CHANGED_LATCH (estado_solicitado = DAY_LOCK)

    • BLOQUEO_NOCTURNO_ESTATAL (estado_solicitado = BLOQUEO_NOCTURNO)

    • STATE_CHANGED_UNKNOWN (estado_solicitado = UNKNOWN)

    • MOTOR_STALL (estado_solicitado = UNKNOWN)

  • lock_id

  • key_local_id (nulo si p.ej. apertura manual mediante pomo o pulsando un botón)

  • nombre_clave_usuario (null si p.ej. apertura manual mediante pomo o pulsando un botón)

  • nombre_clave_admin (null si p.ej. apertura manual mediante pomo o pulsando un botón)

  • key_account_e-mail (null si p.ej. apertura manual mediante pomo o pulsando botón o si PIN de una llave que no está vinculada a una cuenta)

  • nombre_cuenta_clave (nulo si, por ejemplo. apertura manual mediante pomo o pulsando botón o si PIN de una llave que no está vinculada a una cuenta)

Como no todos los sistemas admiten JSON, también es posible, por ejemplo, llamar a una URL para abrir y a otra URL para bloquear (obviamente, entonces la variable estado_solicitado es siempre la misma).

Ir a un estado

También puedes solicitar un webhook cuando el cerrojo vaya a una nueva posición (puede que no alcance la posición si las pilas están casi agotadas, por ejemplo).
Los siguientes eventos establecen el atributo webhook go_to_state con el estado del cerrojo.

  • ir_a_estado

    • ABIERTO

    • BLOQUEO_DÍA

    • BLOQUEO NOCTURNO

  • tipo_evento

    • GO_TO_STATE_INSTANTOPEN_OPEN ( Tocar para abrir ) (go_to_state = OPEN)

    • GO_TO_STATE_INSTANTOPEN_LATCH ( Desbloqueo automático ) (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 = BLOQUEO_NOCTURNO)

    • 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 = BLOQUEO_NOCHE)

    • GO_TO_STATE_MANUAL_UNLOCK_REMOTE_OPEN

    • IR_AL_ESTADO_BLOQUEO_MANUAL_REMOTE_LATCH

    • GO_TO_STATE_MANUAL_LOCK_REMOTE_NIGHT_LOCK

  • lock_id

  • key_local_id (nulo si p.ej. apertura manual mediante pomo o pulsando un botón)

  • nombre_clave_usuario (null si p.ej. apertura manual mediante pomo o pulsando un botón)

  • nombre_clave_admin (null si p.ej. apertura manual mediante pomo o pulsando un botón)

  • key_account_e-mail (null si p.ej. apertura manual mediante pomo o pulsando botón o si PIN de una llave que no está vinculada a una cuenta)

  • nombre_cuenta_clave (nulo si, por ejemplo. apertura manual mediante pomo o pulsando botón o si PIN de una llave que no está vinculada a una cuenta)

Webhook de intensidad Bluetooth y Wi-Fi

Cada pocas horas, o cuando se alimente la esclusa o el puente, se puede enviar una actualización de los niveles de señal. Activa la marca de verificación para recibir esta información.

  • ble_strength (porcentaje - fluctúa mucho, no te preocupes si es bajo)

  • wifi_strength (porcentaje)

  • porcentaje_batería (porcentaje)

  • lock_id (número de identificación de tu cerradura)

Bloquear webhook en línea

Cada pocas horas, o cuando se alimente la esclusa o el puente, se puede enviar una actualización de los niveles de señal. Activa la marca de verificación para recibir esta información.

  • en línea ("1" se envía como valor)

  • lock_id (número de identificación de tu cerradura)

Prueba

Te recomendamos que utilices Webhook.site si quieres verificar que tu cerradura inteligente está llamando a la URL del Webhook. Allí también podrás ver los datos JSON.

Abre/cierra la puerta cuando ocurra algo (webhook entrante)

Si quieres controlar tu cerradura desde un servicio o dispositivo de terceros, puedes hacerlo mediante una llamada HTTPS GET a una URL de LOQED.

Iniciar sesión en la plataforma LOQED Webhooks

imagen
  • Abre la página https://webhooks.loqed.com en tu navegador de Internet.

  • Inicia sesión con tu dirección de correo electrónico y la contraseña que utilizas para acceder a la aplicación LOQED.

    • Atención: Al entrar en esta página saldrás de tu aplicación LOQED, tendrás que volver a entrar en tu aplicación LOQED después de esto.

Crear una clave API

imagen

En esta página puedes añadir webhooks salientes y crear webhooks entrantes.

  • Haz clic en "Añadir nueva clave API".

imagen
  • Escribe un nombre para facilitar la identificación. Puede ser lo que quieras, no tiene por qué tener el mismo nombre que tu clave.

  • Si tienes varios candados, puedes seleccionar el candado adecuado en el menú desplegable que aparece justo al lado de "Seleccionar candado".

  • Ahora puedes pulsar "Añadir clave API".

imagen

Ya has creado la clave API.

Llama a la API

Actualmente, la API admite los siguientes comandos:

  • Abre (la puerta se abre). Se devuelve un objeto JSON vacío.

  • Pestillo (desbloqueado). Se devuelve un objeto JSON vacío.

  • Bloqueo nocturno (bloqueado). Se devuelve un objeto JSON vacío.

  • Estado. ATENCIÓN: por favor, solicita el estado sólo una vez al día. Si solicitas el estado más de 12 veces, se te bloqueará durante 12 horas. En lugar de preguntar por el estado, deberías implementar un webhook que llame a tu servidor, de modo que recibas una notificación instantánea en cuanto cambie el estado del bloqueo. Devuelve las siguientes claves JSON:

    • id (identificación de la cerradura)

    • puente_online (1 si el puente está online, 0 en caso contrario)

    • cerradura_online (1 si la cerradura está online, 0 en caso contrario)

    • porcentaje_de_batería (-1 si la cerradura está desconectada, en caso contrario 0 - 100)

    • tipo_pila (0 = alcalina, 1 = NiMH, 2 = litio (no recargable), 3 = desconocida)

    • estado_cerrojo_numérico (0 = desconocido, 1 = abierto, 2 = cierre_diurno, 3 = cierre_noche)

    • estado_cerrojo (desconocido, abierto, cierre_diurno, cierre_noche)

    • modo_acceso_huésped (1 si está activado, 0 si está desactivado)

    • ayuda_giro (1 si está activada, 0 si está desactivada)

    • tocar_para_conectar (1 si se elimina la restricción de 500 metros de Tocar para Abrir, 0 en caso contrario)

Deja que el servidor LOQED genere la firma digital

Los comandos a la cerradura inteligente deben estar firmados digitalmente. Lo más fácil es dejar que el servidor LOQED genere esta firma. Sólo tienes que utilizar las cuatro URL proporcionadas (apertura, cierre, cierre nocturno, estado) que se muestran en webhooks.loqed.com. Sin embargo, si prefieres guardarte tu clave de encriptación y no enviarla al servidor LOQED, también puedes generar tú mismo la firma digital.

Genera tú mismo la firma digital

En https://app.loqed.com/Backend-API-example/ proporcionamos código de ejemplo (Javascript y PHP) que muestra cómo se crea la firma digital.

¿Ha quedado contestada tu pregunta?