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 ano
Com nossa API de integração você fica livre para desenvolver diversos sistemas e integra-los a Smartbis de forma simplificada. Tenha em mãos uma API completa que permite a conexão simplificada entre seu sistema e a Smartbis.
Onde encontro a documentação da API?
Nossa documentação API está no link: https://sistemafidelidade.docs.apiary.io/ essa documentação é acessória ao Postman, ou seja, você poderá usar a documentação para auxiliar nas suas dúvidas, mas sugerimos que realize os testes diretamente no Postman pelo link: https://documenter.getpostman.com/view/3977729/RWMFtUNJ
Solicitação de assinatura da API
Quando você contrata algum dos planos do Sistema Fidelidade, uma API KEY é gerada para o Administrador e para cada Parceiro. Toda requisição para API Rest deverá conter as credenciais seguindo os parâmetros estabelecidos neste tutorial.
Em troca destas credenciais, o servidor de autorização do Sistema Fidelidade emite uma assinatura de acesso chamada ASSIGN, que será usada pelo integrador para assinar cada transação realizada na API.
Dentro da sua máquina, onde está o seu software (ERP/PDV/CRM), você deve criar uma regra usando o seu editor de texto de preferência (Notepad, VSCode, etc...). Esse regra deve ser escrita na sua linguagem de preferência.
Esta rotina criada irá enviar a cada 24hrs um POST para a API da Smartbis com uma API Key. A Smartbis retornará o seu Assign, o mesmo tem validade de 24hrs, por isso da rotina.
Com esse Assign você pode enviar requisições para a API da Smartbis dentro desse período (24h) depois disso deve solicitar uma nova assinatura.
Exemplo de uma rotina (JavaScript):
Como localizar a API Key?
Uma API KEY é gerada para o Administrador e para cada Parceiro, para acessar:
1 - Em Parceiros > Cadastrar > Operadores você vai encontrar a opção de: API de integração passiva
2 - Efetue login no parceiro em questão, clique sobre o nome do operador no canto superior esquerdo, em seguida clique em API Key. Ela será gerada e aparecerá na tela para você automaticamente.
Para que você utilize nossa API de integração passiva, nos casos em que deseja criar uma conexão com seu software e a plataforma Smartbis ou, nos casos em que nosso replicador de dados for usado em seu servidor local, será necessário a chave de acesso para configurar ambos os ambientes. Para isso, basta seguir até o final as instruções deste video.
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/#