Skip to main content
Guias de desenvolvimento Utilize nossos Guias de Desenvolvimento para mais detalhes sobre integrações de fluxos comuns

Limitações

Estes endpoints foram criados com intuito de comunicação entre sistemas (backend-to-backend) e, portanto, não são compatíveis com CORS e não podem ser utilizados em navegadores e frontends (como React, Angular, Javascript, etc). Se sua integração precisar de um browser você provavelmente deverá utilizar as APIs de Frontend.

Autenticação

Todas as requisições para a API de PDV devem incluir as credenciais de autenticação no header usando Basic Authentication.

Obtendo suas Credenciais

Para obter suas credenciais de API, acesse o painel administrativo da BonifiQ:
1

Abra o Menu Empresa

No canto superior direito do painel administrativo, abra o menu Empresa.
2

Acesse a Área de API

No menu aberto, selecione API para acessar a página Credenciais de API.
3

Crie uma Nova Credencial

Clique no botão CREDENCIAL DE API.
4

Selecione o Tipo Privada

Escolha a opção Privada para gerar credenciais de acesso à API privada (POS).
5

Configure a Credencial

Informe o Nome da credencial, selecione a opção mais adequada à finalidade da integração em Uso da credencial e clique em Gerar credencial.
6

Confirme e Copie as Credenciais

Leia o aviso e clique em ENTENDIDO. Após a criação, copie o Token e a Senha e guarde-os em local seguro. A senha não poderá ser visualizada novamente.

Enviando a Autenticação

A autenticação deve ser enviada no header Authorization usando o esquema Basic Auth. Use o Token gerado como usuario e a Senha como senha. O valor deve ser a codificação Base64 das credenciais no formato usuario:senha.

Exemplo de Implementação

Segurança das Credenciais
  • Nunca exponha suas credenciais em código client-side (frontend, aplicativos mobile, etc.)
  • Armazene as credenciais em variáveis de ambiente ou cofres de segredos
  • Não versione arquivos contendo credenciais em repositórios de código
  • Rotacione as credenciais periodicamente