EmilianoRoldanR

Api Reportes Chamullo

Jun 13th, 2026
32
0
Never
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 3.31 KB | None | 0 0
  1. Buenas tardes, espero se encuentren bien.
  2.  
  3. 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.
  4.  
  5. Autenticación:
  6. • Todas las solicitudes requieren una API Key enviada en headers. X-API-Key: {client_api_key}
  7. • Si la clave es inválida o no se envía, la API responderá con: 401 Unauthorized
  8.  
  9. Flujo general de uso:
  10.  
  11. El consumo de la API se basa en tres pasos:
  12. 1. Solicitar la generación de un reporte.
  13. 2. Consultar estado del reporte.
  14. 3. Descargar el resultado cuando esté disponible.
  15.  
  16. 1 – SOLICITAR REPORTE
  17. Endpoint: POST /reports/{nombre_reporte}
  18.  
  19. Boby (JSON): ejemplo:
  20. {
  21. "from": "2026-01-01T00:00:00",
  22. "to": "2026-01-31T23:59:59",
  23. "group_id": 1,
  24. "local_id": 3
  25. }
  26.  
  27. Parámetros:
  28. o from (datetime ISO8601): Fecha inicio.
  29. o to (datetime ISO8601): Fecha fin.
  30. o group_id (integer): Indicador del grupo.
  31. o local_id (integrer): Indicador del local.
  32.  
  33. Respuesta (JSON):
  34. {
  35. "report_id": "UUID",
  36. "status": "queued"
  37. }
  38.  
  39.  
  40. 2 – SOLICITAR REPORTE
  41. Endpoint: GET /reports/{report_id}/download
  42.  
  43. Respuesta(JSON):
  44. {
  45. "report_id": "UUID",
  46. "status": "queued | running | done | failed",
  47. "rows_total": 1200
  48. }
  49.  
  50. Estados disponibles:
  51. o queued: Pendiente de procesamiento.
  52. o running: En ejecución.
  53. o done: Finalizado correctamente.
  54. o failed: Error durante la ejecución.
  55.  
  56.  
  57. 3– DESCARGAR REPORTE
  58. Endpoint: GET /reports/{report_id}/download
  59.  
  60. Respuesta(JSON):
  61. {
  62. "report": "nombre_reporte",
  63. "report_id": "UUID",
  64. "rows": [...],
  65. "rows_total": 8322
  66. }
  67.  
  68.  
  69. Estructura de datos:
  70.  
  71. Cada reporte devuelve:
  72. • Metadata del reporte.
  73. • Lista de resultados en rows.
  74. • Cantidad total en rows_total.
  75. La estructura interna rows puede variar según reporte.
  76.  
  77. Consideraciones:
  78.  
  79. • El tiempo de generación depende del volumen solicitado.
  80. • No existe limite de rango de fechas, pero rangos grandes pueden aumentar el tiempo de respuesta.
  81. • Los reportes se generan de forma asíncrona.
  82.  
  83. Reportes disponibles:
  84.  
  85. 1. Venta de Productos del Día: cantidad vendida de cada producto separado por día.
  86. 2. Resumen de cuentas: reporte de datos generales de cada ticket.
  87. 3. Productos cancelados.
  88. 4. Reporte de compras (solo backoffice): reporte de compras ingresadas a backoffice.
  89. 5. Descuentos de cuentas: reporte de descuentos generales aplicados al ticket.
  90.  
  91.  
  92. 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.
  93.  
  94.  
Advertisement
Add Comment
Please, Sign In to add comment