Introducción a la documentación API de OVAC
Introducción a la documentación API de OVAC
Introducción a la documentación API de OVAC
La API OVAC permite integrar sistemas externos con la Oficina Virtual de Atención Ciudadana de Councilbox. Esta referencia técnica recoge los métodos disponibles para automatizar el ciclo de vida de una cita, consultar disponibilidad de agenda, gestionar participantes, obtener documentación asociada a una sesión y acceder a información organizativa necesaria para la integración.
La mayoría de operaciones se consumen mediante GraphQL a través de peticiones POST sobre el endpoint /graphql. Para facilitar la lectura y navegación de la documentación, cada operación se presenta como un método independiente, aunque técnicamente comparta el mismo endpoint GraphQL de transporte.
La colección pública utilizada como fuente funcional de esta documentación está disponible en Postman:
Ver colección pública API OVAC en Postman
Salvo las operaciones públicas o el método Login, los métodos requieren autenticación mediante una clave enviada en cabecera:
El token se obtiene ejecutando el método Login con las credenciales asignadas al integrador. Una vez obtenido, debe enviarse en las llamadas protegidas mediante la cabecera x-jwt-token.
Los entornos principales son:
En despliegues privados o dedicados, la URL base puede variar y deberá sustituirse por el dominio corporativo asignado.
Los métodos están agrupados en las siguientes áreas:
Aunque la documentación muestre cada operación como un método independiente, las operaciones GraphQL se ejecutan técnicamente mediante peticiones POST al endpoint /graphql. Esta separación documental permite identificar y consultar cada operación de forma más clara en Fern, especialmente en integraciones donde existen múltiples queries y mutations bajo el mismo endpoint de transporte.
Las respuestas pueden devolver códigos HTTP estándar, pero las reglas de negocio y errores funcionales pueden venir encapsulados dentro del objeto errors del cuerpo JSON, incluso manteniendo un transporte HTTP 200 OK. Por tanto, las integraciones deben validar tanto el código HTTP como el contenido de la respuesta GraphQL.