La API está pensada para equipos de tecnología y proveedores de software. No se contrata una API por sede: una sola suscripción cubre toda la organización.
Desde el panel técnico
- Creación de credenciales con permisos específicos (leer turnos, crear turnos, leer colas).
- Administración de tokens, con expiración.
- Webhooks firmados con HMAC y panel de entregas con reintentos.
- Documentación de referencia y eventos disponibles.
Eventos típicos
- turno llamado, atendido, transferido o completado;
- encuesta respondida;
- mensaje entrante de WhatsApp;
- estado de entrega de un webhook.
Antes de empezar
La API es para equipos de tecnología y proveedores de software. Define primero:
- El caso de uso: qué proceso mejora la integración y cómo lo vas a medir.
- El responsable técnico: quién la construye y quién la mantiene.
- Los permisos mínimos: qué necesita leer o crear el sistema que se conecta.
La guía cuándo integrar y qué preguntar amplía estos criterios.
Puesta en marcha recomendada
- Crea una credencial por integración, con el permiso estrictamente necesario (leer turnos, crear turnos o leer colas).
- Guarda el secreto en un gestor de secretos, no en el código ni en un documento compartido.
- Obtén un token OAuth2 y respeta su expiración: la integración debe renovarlo.
- Si usas webhooks, verifica la firma HMAC de cada evento antes de procesarlo.
- Revisa el panel de entregas: ahí se ven los reintentos y los eventos que fallaron.
- Documenta qué hace la integración, qué credenciales usa y quién responde por ella.
Qué no cubre
- No expone citas: la API permite leer y crear turnos y leer colas.
- No reemplaza la configuración de servicios, prioridades, módulos y usuarios, que se hace en la plataforma.
- No es una integración lista para usar con un sistema de terceros: es una interfaz para construirla.
Errores comunes
- Una sola credencial con todos los permisos para varias integraciones.
- No verificar la firma de los webhooks.
- Procesar dos veces un evento reintentado: el receptor debe tolerar duplicados.
- No revisar nunca el panel de entregas fallidas.
- Dejar activas credenciales de integraciones que ya no se usan.
Preguntas frecuentes
¿Se contrata una API por sede?
No. Una sola suscripción cubre toda la organización.
¿Qué eventos puedo recibir?
Turno llamado, atendido, transferido o completado; encuesta respondida; mensaje entrante de WhatsApp; y el estado de entrega de un webhook.
¿Puedo crear citas por API?
No. La API actual no expone citas.