Not a member of Pastebin yet?
Sign Up,
it unlocks many cool features!
- Buenas tardes, espero se encuentren bien.
- Contamos con una API que provee acceso programático a reportes operativos generados bajo demanda. Está diseñada para ser consumida por sistemas externos y permite solicitar, monitorear y descargar reportes estructurados en formato JSON.
- Autenticación:
- • Todas las solicitudes requieren una API Key enviada en headers. X-API-Key: {client_api_key}
- • Si la clave es inválida o no se envía, la API responderá con: 401 Unauthorized
- Flujo general de uso:
- El consumo de la API se basa en tres pasos:
- 1. Solicitar la generación de un reporte.
- 2. Consultar estado del reporte.
- 3. Descargar el resultado cuando esté disponible.
- 1 – SOLICITAR REPORTE
- Endpoint: POST /reports/{nombre_reporte}
- Boby (JSON): ejemplo:
- {
- "from": "2026-01-01T00:00:00",
- "to": "2026-01-31T23:59:59",
- "group_id": 1,
- "local_id": 3
- }
- Parámetros:
- o from (datetime ISO8601): Fecha inicio.
- o to (datetime ISO8601): Fecha fin.
- o group_id (integer): Indicador del grupo.
- o local_id (integrer): Indicador del local.
- Respuesta (JSON):
- {
- "report_id": "UUID",
- "status": "queued"
- }
- 2 – SOLICITAR REPORTE
- Endpoint: GET /reports/{report_id}/download
- Respuesta(JSON):
- {
- "report_id": "UUID",
- "status": "queued | running | done | failed",
- "rows_total": 1200
- }
- Estados disponibles:
- o queued: Pendiente de procesamiento.
- o running: En ejecución.
- o done: Finalizado correctamente.
- o failed: Error durante la ejecución.
- 3– DESCARGAR REPORTE
- Endpoint: GET /reports/{report_id}/download
- Respuesta(JSON):
- {
- "report": "nombre_reporte",
- "report_id": "UUID",
- "rows": [...],
- "rows_total": 8322
- }
- Estructura de datos:
- Cada reporte devuelve:
- • Metadata del reporte.
- • Lista de resultados en rows.
- • Cantidad total en rows_total.
- La estructura interna rows puede variar según reporte.
- Consideraciones:
- • El tiempo de generación depende del volumen solicitado.
- • No existe limite de rango de fechas, pero rangos grandes pueden aumentar el tiempo de respuesta.
- • Los reportes se generan de forma asíncrona.
- Reportes disponibles:
- 1. Venta de Productos del Día: cantidad vendida de cada producto separado por día.
- 2. Resumen de cuentas: reporte de datos generales de cada ticket.
- 3. Productos cancelados.
- 4. Reporte de compras (solo backoffice): reporte de compras ingresadas a backoffice.
- 5. Descuentos de cuentas: reporte de descuentos generales aplicados al ticket.
- Quedo atento a sus cometarios y si desean avanzar podemos instalar el servicio en uno de los locales para que puedan probar. Es importante tener en cuenta que la computadora madre de cada local debe estar prendida y con conexión estable a internet.
Advertisement
Add Comment
Please, Sign In to add comment