07. APIs REST
Operaciones REST Documentadas
El proyecto expone endpoints REST a través de los diversos controladores. La especificación técnica detallada y esquemas de los requests y responses puede consultarse mediante la interfaz de Swagger/OpenAPI (springdoc-openapi-starter-webmvc-ui 2.8.6).
Endpoints Principales (Basado en Estructura)
| Controlador | URL / Mapeo Base | Operaciones Probables |
|---|---|---|
BillingController | (Ej. /api/v1/billing) | Generación de facturas, consultas. |
AddendaController | (Ej. /api/v1/addenda) | POST /generar (recibe GenerarAddendaRequest). |
PayRollController | (Ej. /api/v1/payroll) | Emisión de nóminas (recibe PayrollRequest). |
PayrollCancellationController | (Ej. /api/v1/payroll/cancellation) | Cancelación masiva de nóminas (PayrollCancellationRequest). |
OnlineInvoiceController | (Ej. /api/v1/invoice/online) | Captura o emisión de facturas. |
DocumentsController | (Ej. /api/v1/documents) | GET de facturas PDF o XML (DocumentXmlPDF). |
Seguridad
- Autenticación manejada mediante
spring-boot-starter-oauth2-resource-server. - Se asume el uso de Bearer JWT Tokens.
Códigos HTTP Comunes
200 OK: Éxito en la operación.201 Created: Addenda/Factura/Recibo generado exitosamente.400 Bad Request: Error de validación (Spring Validation activo).401 Unauthorized: Token inválido o ausente.403 Forbidden: Permisos insuficientes (Scopes faltantes).500 Internal Server Error: Errores no controlados de sistema o dependencias GCP.