Obtener datos de turnos de caja mediante API

Como desarrollador que crea una interface entre tu sistema y Mapal OS, puedes recuperar de forma segura datos de ventas y efectivo a nivel de turno para conciliar en tiempo real las operaciones de caja con los registros de Mapal. La API de Cashrec es RESTful y está protegida con HTTPS y JWT.

Empieza desde: Tu interface de servidor a servidor (cliente de API).

La API de Cashrec

La API de Cashrec es un servicio RESTful para obtener datos de hojas de caja de centros de negocio específicos y rangos de fechas concretos.

Ventajas clave:

• Obtén información detallada de efectivo y ventas por turno.
• Interfaces de servidor a servidor seguras y cifradas (HTTPS + JWT).
• Admite solicitudes en tiempo real y de gran volumen.

Generar un token JWT

REALIZA una solicitud POST a: https://login.mapal-os.com/connect/token

Parámetros:

• grant_type=password
• username=
• password=
• client_id=wf_wap_tp
• client_secret= (contacta con el servicio de atención al Cliente para obtenerlo)
  Campos de respuesta correctos: access_token, expires_in, token_type, refresh_token, scope.

Incluye el token en las solicitudes

• Añade el encabezado: Authorization: Bearer {access_token}

Obtener información de hoja de caja

• Dominio base (OpenAPI): https://cashrec.api.pro.mapal-os.com
• Ruta del endpoint: /api/v1/cashSheet
• Método: GET
• Descripción: Recupera información detallada de la hoja de caja para un periodo y una lista de centros de negocio especificados.

Parámetros de consulta

• startDate (format: yyyy-MM-ddTHH:mm:ss)
• endDate (format: aaaa-MM-ddTHH:mm:ss)
• centersList (comma?separated list of centre IDs)
• Response: 200 OK with cash sheet records for the requested period and centres.

Observaciones: Los nombres de los parámetros pueden distinguir entre mayúsculas y minúsculas. Usa los nombres exactos que se muestran en tu especificación de OpenAPI si difieren (por ejemplo, StartDate frente a startDate). Para ver el esquema completo de solicitud/respuesta y la documentación interactiva, consulta la especificación de OpenAPI en: https://cashrec.api.pro.mapal-os.com/swagger/index.html

Errores de la API

• 400 Bad Request: parámetros faltantes o no válidos. Código de mensaje de ejemplo 100: "Parámetros no válidos. Debes proporcionar StartDate, EndDate y CenterLists válidos."
• 401 No autorizado: token no válido o ausente.
• 404 No encontrado: inquilino no encontrado. Código de mensaje de ejemplo 0: "Configuración del inquilino no encontrada."
• 500 Error interno del servidor: error inesperado del servidor.

Observaciones: Todas las solicitudes deben usar HTTPS. Los tokens caducan (consulta expires_in) y debes actualizarlos cuando caduquen. Si se compromete un token, el proveedor de la API puede revocarlo

---

Originally published at https://help.mapal-os.com/es/analytics-es/cashrec-2/obtener-datos-de-turnos-de-caja-mediante-api/