Objetivo
La pestaña «API y webhooks» permite a los administradores conceder a herramientas de terceros un acceso de lectura a los datos de la organización mediante la API REST, así como recibir notificaciones firmadas cuando determinados datos cambian.
Los recursos disponibles son los inmuebles, las unidades, los contratos de arrendamiento, los propietarios, los anuncios y las transacciones, mientras que los webhooks cubren la creación y la modificación de un contrato de arrendamiento, la recepción de un pago y la llegada de una nueva solicitud.
Dónde encontrarla
- Patrimonio
- Informes
Pestaña «API y webhooks», reservada para los administradores.
Pasos
- Introduzca un «Nombre de la clave» en la tarjeta «Claves de API» y haga clic en «Crear clave».
- Copie la clave inmediatamente mediante «Copiar», ya que no se volverá a mostrar, y transmítala a continuación en la cabecera Authorization de sus llamadas.
- En la tarjeta «Webhooks», introduzca la «Dirección HTTPS», marque los «Eventos» deseados y haga clic en «Añadir webhook».
- Copie el secreto de firma que se muestra, el cual permite a su servidor verificar el origen de cada envío.
- Haga clic en «Enviar prueba» para comprobar la recepción y consulte a continuación los «Envíos recientes».
Conviene saber
- La API está limitada a 120 solicitudes por minuto y por clave, y la documentación de la pestaña describe la paginación y el filtro por fecha de modificación.
- Una respuesta distinta de 2xx provoca hasta tres nuevos envíos del webhook.
- «Revocar» corta de forma inmediata el acceso de las aplicaciones que utilizan una clave, y «Suspender» interrumpe un webhook sin eliminarlo.