Introdução

As APIs da BonfiQ permitem a integração das informações entre a plataforma e sistemas terceiros. Seu uso principal é estender funcionalidades da BonifiQ a cenários que não são atendidos nativamente.

As APIs são divididas em duas categorias: APIs públicas e APIs privadas

Credenciais

Para utilizar as APIs é necessário gerar credenciais. Para isso, acesse o menu "API" no admin da BonifiQ. Você pode criar chaves públicas ou privadas, conforme necessário.

APIs públicas

As APIs públicas permitem que você faça chamadas diretamente do navegador (pelo frontend). Com isso, é possível integrar a BonifiQ com frameworks como React, Vue e jQuery. Essas APIs são habilitadas para CORS.

As APIs públicas são intencionalmente limitadas. Os retornos, por exemplo, não incluem dados sensíveis como e-mail e telefone de consumidores. A razão disso é a segurança: como seu uso objetiva o frontend, então essas chamadas são encaradas como nativamente inseguras.

Para acessar a documentação completa das APIs públicas, acesse:

https://api.bonifiq.com.br/apidocs/public/

O que é possível fazer com a API pública:

- Consultar saldo de pontos ou cashback de um consumidor

- Consultar quantos pontos seriam gerados na compra de um determinado produto

APIs privadas

As APIs privadas são bem mais abrangentes, contendo informações detalhadas em seus retornos. Além disso, permitem muitas operações mais complexas.

Por tanto, essas APIs são mais seguras e requerem que as chamadas sejam feitas via backend. Dessa forma, chamadas CORS não são permitidas, já que o vazamento das chaves de API Privada poderiam se tornar um grave problema de segurança.

Para acessar a documentação completa das APIs públicas acesse:

https://api.bonifiq.com.br/apidocs/private

Webhooks

Com os webhook você pode receber chamadas da BonifiQ direto em sua aplicação. Saiba mais em:

https://suporte.bonifiq.com.br/support/solutions/articles/150000176633-introduc%C3%A3o-aos-webhooks 

Guias

Precisa de mais ajuda? Veja os nossos Guias de integração