Centro de Documentación de la API
Un catálogo completo de los recursos, métodos, rutas y requisitos de autenticación de la API pública v1.
En esta página
1. 4. Catálogo Completo de Endpoints
4. Catálogo Completo de Endpoints
Todas las URI de los recursos públicos y sus métodos HTTP. Los nombres de los archivos de recursos coinciden con los archivos CFC ubicados en resources/.
Estado del Servicio y Autenticación
| Método | Ruta | Recurso | Autenticación |
|---|---|---|---|
GET |
/health-check |
health-check.cfc |
Ninguna |
GET |
/auth/token |
auth-token.cfc |
Bearer |
POST |
/auth/token |
auth-token.cfc |
Ninguna (usuario y contraseña en el cuerpo de la solicitud) |
Servidor
| Método | Ruta | Recurso | Autenticación |
|---|---|---|---|
GET |
/server/constants |
server-constants.cfc |
Bearer |
GET |
/server/timezones |
server-timezones.cfc |
Bearer |
Reloj
| Método | Ruta | Recurso | Autenticación |
|---|---|---|---|
GET |
/clock/shift/user/{UserID} |
clock-shift-user.cfc |
Solo apikey |
GET |
/clock/shift/users |
clock-shift-users.cfc |
Solo apikey |
Usuarios
| Método | Ruta | Recurso | Autenticación |
|---|---|---|---|
GET |
/users |
users.cfc |
Bearer + apikey |
POST |
/user |
user.cfc |
Bearer + apikey |
PUT |
/user/{UserID}/customer/{CustomerID} |
user-customer.cfc |
Bearer + apikey |
DELETE |
/user/{UserID}/customer/{CustomerID} |
user-customer.cfc |
Bearer + apikey |
POST |
/user/{UserID}/customers |
user-customers.cfc |
Bearer + apikey |
DELETE |
/user/{UserID}/customers?CustomerID=... |
user-customers.cfc |
Bearer + apikey |
PUT |
/user/{UserID}/project/{ProjectID} |
user-project.cfc |
Bearer + apikey |
DELETE |
/user/{UserID}/project/{ProjectID} |
user-project.cfc |
Bearer + apikey |
POST |
/user/{UserID}/projects |
user-projects.cfc |
Bearer + apikey |
DELETE |
/user/{UserID}/projects?ProjectID=... |
user-projects.cfc |
Bearer + apikey |
PUT |
/user/{UserID}/accountcode/{AccountCodeID} |
user-accountcode.cfc |
Bearer + apikey |
DELETE |
/user/{UserID}/accountcode/{AccountCodeID} |
user-accountcode.cfc |
Bearer + apikey |
POST |
/user/{UserID}/accountcodes |
user-accountcodes.cfc |
Bearer + apikey |
DELETE |
/user/{UserID}/accountcodes?AccountCodeID=... |
user-accountcodes.cfc |
Bearer + apikey |
PATCH |
/user/{UserID}/archive |
user-archive.cfc |
Bearer + apikey |
PATCH |
/user/{UserID}/archive/resolve |
user-archive-resolve.cfc |
Bearer + apikey |
Elementos — Listas
| Método | Ruta | Recurso |
|---|---|---|
GET |
/items/customer |
items-customer.cfc |
GET |
/items/project |
items-project.cfc |
GET |
/items/accountcode |
items-accountcode.cfc |
GET |
/items/vendor |
items-vendor.cfc |
GET |
/items/event |
items-event.cfc |
Elementos — Individuales
| Método | Ruta | Recurso |
|---|---|---|
GET |
/item/customer/{CustomerID} |
item-customer.cfc |
GET |
/item/project/{ProjectID} |
item-project.cfc |
GET |
/item/accountcode/{AccountCodeID} |
item-accountcode.cfc |
GET |
/item/vendor/{VendorID} |
item-vendor.cfc |
POST |
/item/vendor/{VendorID} |
item-vendor.cfc (crear; el ID de la ruta es un marcador de posición, utiliza 0) |
PATCH |
/item/vendor/{VendorID} |
item-vendor.cfc |
DELETE |
/item/vendor/{VendorID} |
item-vendor.cfc |
PATCH |
/item/vendor/{VendorID}/archive |
item-vendor-archive-restore.cfc |
PATCH |
/item/vendor/{VendorID}/restore |
item-vendor-archive-restore.cfc |
GET |
/item/event/{EventID} |
item-event.cfc |
POST |
/item/event/{EventID} |
item-event.cfc (crear; utiliza 0 como marcador de posición en la ruta) |
PATCH |
/item/event/{EventID} |
item-event.cfc |
DELETE |
/item/event/{EventID} |
item-event.cfc |
PATCH |
/item/event/{EventID}/archive |
item-event-archive-restore.cfc |
PATCH |
/item/event/{EventID}/restore |
item-event-archive-restore.cfc |
Temporizadores de Proyectos
| Método | Ruta | Recurso |
|---|---|---|
GET |
/project/timers/{UserID} |
project-timers.cfc |
Registros
| Método | Ruta | Recurso |
|---|---|---|
GET |
/record/hourly/history/{RecordID} |
record-hourly-history.cfc |
GET |
/record/project/history/{RecordID} |
record-project-history.cfc |
GET |
/record/expense/history/{RecordID} |
record-expense-history.cfc |
GET |
/record/expense/receipt/{RecordID} |
record-expense-receipt.cfc |
Informes
| Método | Ruta | Recurso | Notas |
|---|---|---|---|
GET |
/report/user/info |
report-user-info.cfc |
|
GET, POST |
/report/hourly/customizable/processed |
report-hourly-customizable-processed.cfc |
Utiliza POST para solicitudes con grandes cantidades de datos |
GET, POST |
/report/hourly/customizable/unprocessed |
report-hourly-customizable-unprocessed.cfc |
|
GET |
/report/hourly/filter/items |
report-hourly-filter-items.cfc |
|
GET, POST |
/report/hourly/location |
report-hourly-location.cfc |
|
GET, POST |
/report/hourly/record/overlapping |
report-hourly-record-overlapping.cfc |
|
GET, POST |
/report/hourly/record/history |
report-hourly-record-history.cfc |
|
GET |
/report/hourly/payroll/periods |
report-hourly-payroll-periods.cfc |
|
GET |
/report/hourly/payroll/period/{PayrollID} |
report-hourly-payroll-period.cfc |
|
GET, POST |
/report/hourly/payroll/preview |
report-hourly-payroll-preview.cfc |
|
GET, POST |
/report/project/customizable |
report-project-customizable.cfc |
|
GET |
/report/project/filter/items |
report-project-filter-items.cfc |
|
GET, POST |
/report/expense/customizable |
report-expense-customizable.cfc |