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

Acesse o Menu API

No painel administrativo, navegue até o menu API na barra lateral.
2

Criar Nova Credencial

Clique no botão + CREDENCIAL para criar uma nova credencial de API.
3

Selecione o Tipo Privada

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

Copie as Credenciais

Após a criação, você receberá um usuário e senha de API. Guarde essas informações em local seguro.

​
Enviando a Autenticação

A autenticação deve ser enviada no header Authorization usando o esquema Basic Auth. O valor deve ser a codificação Base64 das credenciais no formato usuario:senha. 
Authorization: Basic {base64(usuario:senha)}

​
Exemplo de Implementação

# Credenciais de exemplo:
# Usuário: meu_usuario_api
# Senha: minha_senha_secreta

# Codificação Base64 de "meu_usuario_api:minha_senha_secreta"
# Resultado: bWV1X3VzdWFyaW9fYXBpOm1pbmhhX3NlbmhhX3NlY3JldGE=

curl -X POST "https://api.bonifiq.com.br/v1/pvt/POS/rewards/available" \
  -H "Authorization: Basic bWV1X3VzdWFyaW9fYXBpOm1pbmhhX3NlbmhhX3NlY3JldGE=" \
  -H "Content-Type: application/json" \
  -d '{"customerId": "12345678900", "purchaseValue": 150.00}'
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