API abierta, webhooks y miniaplicaciones para administración de edificios
Cuando no existe un enlace listo entre Unitify y otro sistema, la API abierta es la puerta de entrada. Es la misma interfaz que usan los propios productos, con documentación pública.
Esta página trata de la API, los webhooks, las miniaplicaciones y el acceso desde su propio servicio: qué hace cada uno, cómo se accede y qué se configura por proyecto.
En resumen
La API GraphQL, los webhooks, las miniaplicaciones y el acceso con OpenID Connect funcionan hoy y están documentados públicamente. El acceso a la API forma parte del plan Pro. Dar acceso a un sistema o proveedor concreto, y el trabajo de mapear sus datos, se configura por proyecto.
Para qué sirve esta conexión
Conectar cualquier sistema que pueda llamar a una API
Un sistema contable o ERP, una plataforma de medidores, un chatbot o su propio software lee y escribe datos de Unitify.
Reaccionar a los cambios
Los webhooks avisan a su sistema de que ha cambiado una solicitud, un contacto o una factura, en lugar de que pregunte una y otra vez.
Construir sobre la plataforma
Una miniaplicación lleva su servicio al panel de administración o a la app del vecino, y los usuarios no salen de Unitify.
Qué datos se mueven y en qué sentido
Cada línea dice si funciona hoy o se configura para su proyecto.
- Funciona hoy
Leer y escribir: API GraphQL
Edificios, viviendas, contactos, solicitudes, lecturas de medidores, noticias y facturas se pueden consultar, crear y actualizar. Los registros de facturación y de pago llevan un importId para el identificador de su sistema.
- Funciona hoy
Eventos hacia fuera: webhooks
Las suscripciones abarcan solicitudes, contactos, organizaciones, documentos y facturas, con los campos y filtros que elija. Una factura también puede llamar a una dirección cuando cambia el estado de su pago.
- Funciona hoy
Dentro del producto: miniaplicaciones
Un servicio web se ejecuta en el panel de administración o en la app del vecino y habla con la aplicación principal mediante la biblioteca Bridge.
- Funciona hoy
Acceso: OpenID Connect
Un servicio con OpenID Connect permite que sus usuarios se autoricen en la API de Unitify sin una segunda contraseña.
- Se configura por proyecto
Mapeo y construcción del enlace
Decidir qué campos suyos corresponden a los nuestros y construir el intercambio para su sistema.
Cómo se accede
La documentación es pública. El plan y los permisos de acceso son lo que configuramos con usted.
- Funciona hoy
Lea la documentación
El modelo de datos, la autorización y los ejemplos son públicos.
Abrir la documentación de la API - Funciona hoy
Pruébelo en un playground
La documentación incluye un tutorial paso a paso del playground para las primeras consultas.
Abrir el tutorial del playground - Funciona hoy
Direcciones de webhooks
Las suscripciones y direcciones de webhook las damos de alta nosotros. Pídalo y añadimos la suya.
Leer el ejemplo de webhook - Funciona hoy
Miniaplicaciones y acceso
Las miniaplicaciones usan la biblioteca Bridge; el acceso desde su propio servicio usa OpenID Connect.
Abrir la documentación de Bridge
Qué aporta usted
El caso de uso
Qué necesita leer o escribir su sistema y con qué frecuencia.
Una organización de prueba
Una organización donde probar el acceso antes de que toque datos reales.
Un contacto de su lado
Alguien que sepa leer documentación de API y recibir un webhook.
Los límites, con franqueza
- El acceso a la API forma parte del plan Pro. La página de precios vigente tiene los detalles de cada plan.
- No hay SAML. El acceso desde otro servicio, para personal o vecinos, usa OpenID Connect, y registramos su servicio como proveedor.
- Un enlace con su sistema es un proyecto. La API lo hace posible; mapear sus datos y construir el intercambio es trabajo que acordamos con usted.
API abierta y webhooks: preguntas
¿Hay una API pública?
Sí. La API es GraphQL y su documentación es pública: modelo de datos, autorización, ejemplos y un tutorial del playground.
¿Qué puedo leer y escribir?
Edificios, viviendas, contactos, solicitudes, lecturas de medidores, noticias, facturas y más. Los objetos se leen, crean y actualizan de la misma manera.
¿Hay webhooks?
Sí. Las suscripciones abarcan solicitudes, contactos, organizaciones, documentos y facturas, y una factura puede llamar a una dirección cuando cambia el estado de su pago. La suscripción la configuramos nosotros.
¿Puede mi propio servicio ejecutarse dentro de Unitify?
Sí, como miniaplicación en el panel de administración o en la app del vecino, con la biblioteca Bridge.
¿Pueden mis usuarios entrar en la API con las cuentas de mi servicio?
Sí, si su servicio ofrece OpenID Connect: registramos su servicio como proveedor. No se ofrece SAML.
¿El acceso a la API es gratuito?
El acceso a la API forma parte del plan Pro. La página de precios vigente tiene los detalles de cada plan.
Relacionado
Díganos qué sistema usa
Empiece gratis con un edificio, sin tarjeta y sin llamada. O reserve una demostración y nombre los sistemas y dispositivos que quiere conectar; confirmamos cada uno antes de que decida.