Envie `api_key` e `api_secret` para receber o `access_token`.
API Pública Smartbis
Integre vendas, clientes, cupons e vouchers ao motor de fidelidade.
API REST v2 para integrações server-to-server com autenticação Bearer Token, comunicação JSON e endpoints para acionar recompensas em tempo real.
Fluxo básico
Da autenticação até a recompensa automática.
O uso principal da API é registrar vendas externas para que a Smartbis processe cashback, pontos, vouchers e comunicações conforme as regras da conta.
Use CPF, telefone, e-mail ou ID para manter o cliente sincronizado.
Envie `sale_amount` por CPF ou `customer_id` para acionar o motor de fidelidade.
Consulte cupons, vouchers, categorias e estoque quando a operação precisar.
Referência rápida dos principais endpoints.
Esta parte funciona como uma porta de entrada antes da documentação Swagger completa.
POST
/auth/token
Gera o token Bearer para autenticar as próximas chamadas.
Auth
GET
/customers
Lista clientes ou filtra por CPF com paginação opcional.
Customers
POST
/customers
Cria cliente com nome, telefone, senha e dados complementares.
Customers
POST
/sales
Registra venda por CPF ou ID do cliente e aciona a regra de fidelidade.
Sales
GET
/coupons
Lista cupons/recompensas disponíveis para a operação.
Coupons
PATCH
/coupons/{coupon_id}/stock
Atualiza estoque de uma recompensa específica.
Coupons
GET
/vouchers
Lista vouchers com paginação opcional.
Vouchers
POST
/vouchers/{voucher_code}/validate
Valida voucher pelo código informado.
Vouchers
Objetos principais
Recursos da API organizados pelo uso da operação.
A página apresenta os domínios da API em linguagem de produto, enquanto a documentação Swagger mantém os detalhes de schema, parâmetros e respostas.
Cadastro, busca por CPF, telefone, e-mail e dados para relacionamento.
Registro de compras externas para gerar cashback, pontos ou vouchers.
Listagem e controle de estoque de recompensas disponíveis.
Consulta e validação de vouchers usados pelo cliente.
Criação e listagem de categorias usadas na organização da operação.
Geração de token Bearer com `api_key` e `api_secret`.
Precisa conectar um sistema próprio?
Use a documentação interativa para testar endpoints, validar payloads e alinhar o fluxo ideal com a equipe técnica.