Introducción

BistroApi es la API pública de Bistrosoft que permite consultar el detalle de transacciones de los comercios asociados a la cuenta del usuario autenticado. Está pensada para integrar los datos operativos de los comercios con ERPs, BI, conciliación contable y cualquier otro consumidor programático.

Antes de empezar

Para consumir la API necesitas:

Credenciales de BistroWeb — son las mismas que utilizas en la plataforma web de Bistrosoft.
Un rol habilitado por el equipo de Bistrosoft (ApiUser para v1, Administrador para v2). Si el usuario no tiene el rol correspondiente, los endpoints de reportes devuelven 403 Forbidden.

Primer llamado en 3 pasos

1. Obtener un token

POST /api/v1/Token
Content-Type: application/json

{
  "username": "[email protected]",
  "password": "tu-contraseña"
}

Respuesta:

{
  "token": "eyJhbGciOi...",
  "expiration": "2026-04-24T18:32:00Z"
}

2. Llamar a un endpoint

Incluye el token en el header Authorization de cada solicitud:

GET /api/v1/TransactionDetailReport?fromDate=2026-04-01&toDate=2026-04-22
Authorization: Bearer eyJhbGciOi...

El token incluye en sus claims los códigos de comercio (shop_code) habilitados para el usuario. La API filtra automáticamente la información para devolver solo los datos de esos comercios.

3. Renovar el token al vencer

La API no emite refresh tokens. Cuando el token expira (2 días por defecto), repite el paso 1 para obtener uno nuevo.

Versiones disponibles

Versión	Características
v1	Versión estable. Reporte de detalle de transacciones con paginación clásica. Montos como string.
v2	Versión ampliada. Incluye ítems consumidos por transacción, montos como valores numéricos, filtrado por múltiples comercios separados por coma.

Los endpoints equivalentes comparten nombre de ruta; solo cambia el número de versión (/api/v1/... vs /api/v2/...).

Próximos pasos

Autenticación — Detalle del flujo de login y roles.
Token — Endpoint de obtención de token (v1 y v2).
TransactionDetailReport — Reporte de detalle de transacciones (v1 y v2).