Como Funciona e Como usar a API de Integração?
Posso desenvolver minha aplicação e conectar a Smartbis?
Henrique Tischer
Última atualização há um mês
A API de Integração da Smartbis permite que você conecte seus próprios sistemas (ERP, PDV, CRM, entre outros) diretamente à plataforma Smartbis, possibilitando trocas automáticas de informações de forma simples e segura.
Como desenvolver minha aplicação e conectar à Smartbis?
Sim. Você pode desenvolver uma aplicação própria e integrar com a Smartbis usando nossa API REST. A API fornece acesso completo às funcionalidades da plataforma, permitindo automatizar processos como cadastro de clientes, lançamentos de vendas, validação de vouchers e muito mais.
Onde encontro a documentação da API?
• Documentação principal:
https://sistemafidelidade.docs.apiary.io/
• Para testes, recomendamos usar o Postman:
Como funciona a autenticação via API?
Quando você contrata um dos planos da Smartbis, uma API Key é gerada automaticamente para o Administrador e para cada Parceiro cadastrado.
O processo de autenticação é feito em duas etapas:
1. Solicitação de assinatura (ASSIGN):
• Seu sistema envia uma requisição com a API Key.
• O servidor da Smartbis retorna um ASSIGN, válido por 24 horas.
2. Envio das requisições:
• Durante esse período de validade (24h), você poderá realizar requisições usando esse ASSIGN.
• Após 24h, é necessário gerar um novo ASSIGN.
É recomendado configurar uma rotina automática em seu sistema para solicitar uma nova assinatura diariamente.
Como localizar a API Key?
Cada parceiro tem sua própria API Key, que pode ser acessada da seguinte forma:
• Acesse o Painel de Controle > Menu Parceiros.
• Clique no Parceiro desejado > Operadores.
• Encontre a opção “API de Integração Passiva”.
Ou diretamente na conta do parceiro:
• Faça login no parceiro.
• Clique sobre o nome do operador (canto superior esquerdo).
• Selecione “API Key” para visualizá-la na tela.
Como configurar a API com seu software?
Para realizar a integração:
• Utilize sua linguagem de programação preferida (PHP, Python, JavaScript, etc.).
• Crie uma rotina automática (diária) que realiza uma requisição POST para a Smartbis usando sua API Key.
• A API retornará um ASSIGN válido por 24 horas, que será utilizado nas suas requisições seguintes.
Essa rotina garante a autenticação contínua da sua aplicação com a Smartbis.
Para detalhes técnicos sobre a implementação dessa rotina, consulte a documentação mencionada acima.
Dúvidas Frequentes
Como consultar ou revogar o (assign) da API?
Depois de solicitar sua assinatura, ela não poderá ser revogada nem consultada, a responsabilidade pelo armazenamento e controle é do solicitante. Aguarde 24h e solicite uma nova assinatura.
Solicitei a assinatura (assign) e não salvei e agora? Como solicitar uma nova assinatura da API?
Você deve aguardar 24h para solicitar uma nova assinatura porque se você tentar gerar outra assinatura não será permitido, o sistema retornará um erro de assinatura existente.
A documentação da API não me ajudou, como devo proceder?
Utilize o postman (https://documenter.getpostman.com/view/3977729/RWMFtUNJ) primeiro faça seus testes no Postman, só depois de validar, leve para seus scripts para ambiente de produção.
O que é uma API REST?
API REST é uma série de caminhos entre dois softwares que se comunicam entre si via JSON. A Smartbis possui API Rest para você conseguir integrar seu software ao nosso. aqui estáo link para a documentação: https://sistemafidelidade.docs.apiary.io/#