Envie a API Key do administrador ou de um operador autorizado e uma Secret Key válida para receber o `access_token`.
API Pública Smartbis v1.9.0
Integre vendas, clientes, dependentes, benefícios e elegibilidade ao motor de fidelidade.
API REST v2 para integrações server-to-server com autenticação Bearer Token, escopos explícitos, escritas idempotentes e controle do acesso de titulares e dependentes aos planos.
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 documento, telefone ou ID para localizar e manter o cliente sincronizado.
Envie `sale_amount` por documento, telefone 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 documento, telefone ou ID, com paginação opcional.
Customers
POST
/customers
Cria cliente com nome, telefone, senha e dados complementares.
Customers
PATCH
/customers/{customer_id}
Atualiza os dados cadastrais suportados e permite ativar ou desativar o cliente pelo campo `active`.
Customers
GET
/customers/{customer_id}/referrals
Lista apenas os clientes indicados diretamente pelo cliente informado, respeitando as permissões de visualização. A consulta não gera créditos; eventuais recompensas seguem o processo existente e aparecem no extrato de transações.
Referrals
GET
/partners
Lista parceiros próprios e permite consultar os detalhes de cada cadastro.
Partners
POST
/partners
Cadastra um parceiro respeitando as regras e os limites do plano.
Partners
PATCH
/partners/{partner_id}
Atualiza, ativa ou desativa um parceiro próprio.
Partners
POST
/sales
O administrador registra na operação principal. Para registrar em uma loja específica, use a API Key de um operador autorizado nela.
Sales
GET
/customers/{customer_id}/transactions
Consulta o extrato paginado, o saldo atual e, quando aplicável, a composição do saldo por parceiro.
Transactions
GET
/coupons
Lista cupons/recompensas disponíveis para a operação.
Coupons
POST
/coupons
Cadastra uma recompensa usando as regras e os limites existentes da operação.
Coupons
PATCH
/coupons/{coupon_id}
Atualiza, ativa ou desativa uma recompensa existente.
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
POST
/vouchers/manual-redemptions
Executa o resgate manual existente, verificando saldo e registrando o voucher e a movimentação de forma atômica.
Vouchers
GET
/plans
Lista os planos para participantes configurados no clube.
Plans
GET
/subscriptions
Lista assinaturas e permite filtrar acessos ativos, inadimplentes, vencidos ou cancelados.
Subscriptions
GET
/customers/{customer_id}/dependents
Consulta dependentes vinculados ao titular e sua elegibilidade herdada.
Dependents
POST
/customers/{customer_id}/dependents
Cadastra dependente respeitando empresa, titular e limite do plano.
Dependents
PATCH
/dependents/{dependent_id}
Atualiza os dados suportados do dependente; sua elegibilidade continua herdada do titular.
Dependents
PATCH
/categories/{category_id}
Atualiza, ativa ou desativa uma categoria sem remover seus vínculos existentes.
Categories
GET
/eligibility/reconciliation
Concilia vidas ativas por plano e período, com paginação.
Eligibility
POST
/webhooks
Cadastra destinos HTTPS para eventos assinados de mudança de elegibilidade.
Webhooks
POST
/access-links
Emite acesso assinado, curto e de uso único para fornecedores vinculados.
Access
PATCH
/subscriptions/{customer_id}
Ativa, suspende ou encerra o acesso do participante a um plano sem alterar cobranças no gateway.
Subscriptions
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, atualização, ativação e desativação por documento, telefone ou ID, respeitando a visibilidade do operador.
Registro de compras externas para gerar cashback, pontos ou vouchers.
Cadastro, atualização, ativação, desativação e controle de estoque das recompensas.
Consulta, validação e resgate manual pelo processo oficial, com verificação de saldo.
Criação, atualização, ativação e desativação das categorias da operação.
Mantém parceiros próprios e consulta indicações diretas sem criar uma rede multinível ou alterar recompensas.
Consulta planos e sincroniza o status de acesso dos participantes com sistemas e fornecedores externos.
Mantém vínculos familiares e concilia titulares e dependentes ativos sem transportar dados clínicos.
Entrega eventos assinados com retentativas e gera tokens temporários de uso único para fornecedores externos.
A API Key identifica quem registra a operação. O administrador registra vendas na operação principal; para uma loja específica, utilize a API Key de um operador autorizado nela.
Precisa conectar um sistema próprio?
Use a documentação interativa para testar endpoints, validar payloads e implementar o fluxo adequado para sua integração.