Enviar ventas en tiempo real mediante API

Como desarrollador que crea una Interface entre tu sistema y Mapal OS, puedes enviar ventas en tiempo real mediante la API para que las cifras estén disponibles al instante para Informes y previsiones. La API de ventas en tiempo real es RESTful y está protegida con HTTPS y JWT.

Empieza desde: Tus interfaces de servidor a servidor (cliente de API).

API de ventas en tiempo real

La API de ventas en tiempo real es un servicio RESTful para enviar datos de ventas en vivo de forma segura.

Ventajas clave:

• Actualizaciones inmediatas de las cifras de ventas.
• Asegura la conexión de servidor a servidor (HTTPS + JWT).
• Permite aplicar filtros flexibles por Centro y por día de negocio.

Generar un token JWT

ENVÍA 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 Atención al Cliente para obtenerlo)

La respuesta correcta incluye: access_token, expires_in, token_type, refresh_token, scope.

Incluye el token en las solicitudes

• Añadir encabezado: Authorization: Bearer {access_token}

Enviar ventas en tiempo real

• Dominio base: https://api.workforce.mapal-os.com/sales
• Ruta del endpoint: /api/v1/business-unit/{unitId}/real-time-sales
• Método: GET (si tu especificación OpenAPI muestra un método diferente, sigue la especificación)

Parámetros / campos de carga útil

• unitId (ruta, entero)

• businessDay (cadena, yyyy-MM-dd)

• realTimeSales (array de objetos):

  • currencyId (cadena)

  • salesTypeId (cadena)

  • timeSlotStart (cadena, fecha y hora)

  • netSales (decimal)

  • grossSales (decimal)

  • numChecks (entero)

  • numGuests (entero)

Revisar ventas enviadas

• Ve a Analytics > Sales en Mapal OS.

Observaciones:

• Todas las solicitudes deben usar HTTPS.

• Los tokens caducan (expires_in) y debes generarlos de nuevo.

• Puedes revocar los tokens si se ven comprometidos.

Gestión de errores

• 400 Bad Request: ID de Unit no válida; desajuste de día laborable; desajuste de Monedas o tipo de venta; Horarios no válidos.

• 401 No autorizado: Token no válido o faltante.

• 404 No encontrado: Inquilino o configuración del inquilino no encontrado.

• Error interno del servidor 500.

---

Originally published at https://help.mapal-os.com/es/analytics-es/ventas/enviar-ventas-en-tiempo-real-mediante-api/