API de Citas y Turnos
Esta plataforma esta orientada a la gestion de turnos, colas y cita previa para organizaciones que necesitan operar con reglas por sede, servicio, empleado y canal.
Esta documentación está pensada para equipos técnicos que necesiten entender la API REST, autenticarse correctamente y recorrer los principales dominios funcionales del sistema.
Si vas a empezar a integrar la plataforma, sigue este orden:
- Revisa Autenticación.
- Lee Primeros pasos.
- Pasa a la Referencia API.
Qué cubre esta documentación
- Autenticación de empleados mediante Laravel Sanctum.
- Gestión de citas y disponibilidad.
- Operativa de turnos sin cita previa.
- Calendarios, estados, tipos, empleados y mostradores.
- Configuración funcional, banners y plantillas de correo.
- Referencia OpenAPI para consumo e integración.
Visión funcional
La API refleja los bloques principales del producto:
| Dominio | Objetivo |
|---|---|
Auth | Registro e inicio de sesión de empleados. |
Appointments | Reserva, consulta, filtrado y disponibilidad de citas. |
Shifts | Turnos presenciales sin cita previa. |
Calendars | Días operativos, huecos y reglas de agenda. |
Employees | Gestión del personal y sus asignaciones. |
OverTheCounter | Mesas, mostradores o puntos de atención. |
Settings y Options | Configuración global y branding operativo. |
Banners y Email Templates | Elementos de comunicación y experiencia. |
Características operativas relevantes
- Arquitectura pensada para escenarios multisede.
- Soporte para cita previa y atención presencial.
- Reglas por tipo de servicio, disponibilidad y prioridad.
- Respuestas enriquecidas con relaciones de negocio.
- Casos legacy donde algunos campos aceptan JSON serializado como texto.
Cómo empezar
1. Obtener credenciales válidas
Usa POST /auth/login o POST /auth/register para obtener un token Bearer reutilizable.
2. Configurar el cliente HTTP
Incluye siempre la cabecera:
Code
3. Probar los recursos troncales
Las primeras rutas recomendadas suelen ser:
Code
Entornos definidos en la especificación actual
Code
Convenciones importantes
- Los endpoints protegidos usan Bearer tokens emitidos por Sanctum.
- Los listados paginados siguen la estructura nativa de Laravel.
- Parte de la API devuelve relaciones como
employee,type,stateytranslations. - Algunos recursos heredados mantienen formatos de entrada no completamente normalizados.
Ruta recomendada dentro de esta documentación
Autenticación
Empieza por Autenticación para validar correctamente login, token y cabeceras.
Puesta en marcha
Continúa por Primeros pasos para revisar base URLs, convenciones y dominios.
Referencia técnica
Termina en la Referencia API, donde tienes endpoints, esquemas y ejemplos.
Alcance de esta instancia de documentación
Esta instancia de Zudoku se ha adaptado como documentacion generica, con el objetivo de ofrecer una referencia tecnica clara, navegable y util para integracion real.