Planes
Buscar en el sitio
API Pública Smartbis

Integra ventas, clientes, cupones y vouchers en el motor de fidelidad.

API REST v2 para integraciones servidor a servidor con autenticación Bearer Token, comunicación JSON y endpoints para activar recompensas en tiempo real.

Flujo básico

Desde la autenticación hasta la recompensa automática.

El uso principal de la API es registrar ventas externas para que Smartbis procese cashback, puntos, vouchers y comunicaciones según las reglas de la cuenta.

01 Generar token

Envía `api_key` y `api_secret` para recibir el `access_token`.

02 Crear o localizar cliente

Usa CPF, teléfono, email o ID para mantener el cliente sincronizado.

03 Registrar venta

Envía `sale_amount` por CPF o `customer_id` para activar el motor de fidelidad.

04 Validar beneficios

Consulta cupones, vouchers, categorías y stock cuando la operación lo requiera.

Referencia rápida a los principales endpoints.

Esta parte funciona como una puerta de entrada antes de la documentación Swagger completa.

POST /auth/token

Genera el token Bearer para autenticar las próximas llamadas.

Auth
GET /customers

Lista clientes o filtra por CPF con paginación opcional.

Customers
POST /customers

Crea cliente con nombre, teléfono, contraseña y datos complementarios.

Customers
POST /sales

Registra venta por CPF o ID del cliente y activa la regla de fidelidad.

Sales
GET /coupons

Lista cupones/recompensas disponibles para la operación.

Coupons
PATCH /coupons/{coupon_id}/stock

Actualiza inventario de una recompensa específica.

Coupons
GET /vouchers

Lista vouchers con paginación opcional.

Vouchers
POST /vouchers/{voucher_code}/validate

Valida voucher por el código informado.

Vouchers
Objetos principales

Recursos de la API organizados por uso de la operación.

La página presenta los dominios de la API en lenguaje de producto, mientras que la documentación Swagger mantiene los detalles de esquema, parámetros y respuestas.

Clientes

Registro, búsqueda por CPF, teléfono, correo electrónico y datos para relación.

ventas

Registro de compras externas para generar cashback, puntos o vouchers.

Cupones

Listado y control de inventario de recompensas disponibles.

Cupones

Consulta y validación de vouchers usados por el cliente.

categorías

Creación y listado de categorías utilizadas en la organización de la operación.

Autenticación

Generación de token Bearer con `api_key` y `api_secret`.

¿Necesitas conectar un sistema propio?

Utiliza la documentación interactiva para probar endpoints, validar payloads y alinear el flujo ideal con el equipo técnico.

Abrir Swagger