Centro de Documentación de la API
Consulta turnos registrados y temporizadores de proyectos, revisa el historial de registros y genera archivos PDF de recibos de gastos.
7. Reloj y Turnos
Los endpoints del reloj se autentican únicamente con la apikey (sin token Bearer). La documentación Javadoc indica que el encabezado debe tener el formato Authorization: <apikey>.
GET /clock/shift/user/{UserID}
curl -s "$API_BASE/clock/shift/user/101" \
-H "Authorization: $API_KEY"
Devuelve el estado actual del reloj, las marcas de tiempo de entrada y descanso (GMT + hora local), la ubicación, la dirección IP, la información de la foto, las alertas y las horas del turno actual y del día. Requiere que el perfil del administrador tenga acceso al usuario seleccionado.
GET /clock/shift/users
| Parámetro | Ubicación | Notas |
|---|---|---|
UserList |
query | ID de usuarios separados por comas |
AdminUserID |
query | Limita los resultados a los usuarios supervisados por este administrador |
curl -s "$API_BASE/clock/shift/users?UserList=101,102&AdminUserID=50" \
-H "Authorization: $API_KEY"
12. Temporizadores de Proyectos
GET /project/timers/{UserID}
| Parámetro | Ubicación | Notas |
|---|---|---|
UserID |
path | Obligatorio |
CustomerID, ProjectID, AccountCodeID |
query | Filtros CSV numéricos opcionales |
curl -s "$API_BASE/project/timers/101?CustomerID=10&ProjectID=200" \
-H "Authorization: Bearer $TOKEN" \
-H "apikey: $API_KEY"
Requiere acceso de administrador al usuario seleccionado.
13. Registros
Historial de Revisiones
curl -s "$API_BASE/record/hourly/history/9001" \
-H "Authorization: Bearer $TOKEN" -H "apikey: $API_KEY"
curl -s "$API_BASE/record/project/history/9002" \
-H "Authorization: Bearer $TOKEN" -H "apikey: $API_KEY"
curl -s "$API_BASE/record/expense/history/9003" \
-H "Authorization: Bearer $TOKEN" -H "apikey: $API_KEY"
Requiere acceso de administrador al empleado al que pertenece el registro. Un RecordID no válido o la falta de permisos devuelve mensajes en errors.
PDF de Recibo de Gastos
GET /record/expense/receipt/{RecordID}
| Parámetro | Valor predeterminado | Valores |
|---|---|---|
Orientation |
PORTRAIT |
PORTRAIT, LANDSCAPE |
curl -s "$API_BASE/record/expense/receipt/9003?Orientation=LANDSCAPE" \
-H "Authorization: Bearer $TOKEN" \
-H "apikey: $API_KEY"
La respuesta utiliza los campos del servicio de informes (Msg, MsgType, Data con FileURL / RedirectURL / FileName cuando la operación se completa correctamente).