API REST
GekkoCheckin expone una API REST documentada con OpenAPI 3.0.
Especificación OpenAPI
La especificación completa está en backend/openapi.json y se sirve en tiempo de ejecución en:
Swagger UI
Interfaz interactiva para explorar y probar la API:
Requiere tener la aplicación desplegada. Ejemplo: https://api.gekkocheckin.mywire.org/api/swagger-ui
Especificación en el repositorio
Para consultar la API sin tener la app desplegada, el archivo OpenAPI está en el repo:
- backend/openapi.json — especificación completa
Principales grupos de endpoints
| Grupo | Descripción |
|---|---|
| Auth | Registro, login, activación, recuperación |
| Places | Establecimientos, acceso, configuración |
| Staff | Empleados, roles, permisos |
| Time control | Fichaje entrada/salida, historial, modificaciones |
| Shifts | Turnos, asignaciones, auto-asignar |
| Documents | Nóminas, contratos, tablón |
| Announcements | Comunicados internos |
| Reports | Informes de horas, cobertura, rendimiento |
Autenticación
La mayoría de endpoints requieren autenticación mediante token Bearer en el header:
El token se obtiene en el login (POST /api/auth/login) y se renueva automáticamente.
Actualizar la especificación
Cuando se añadan o modifiquen endpoints públicos, actualizar backend/openapi.json según las reglas en definition-of-done.