> ## Documentation Index
> Fetch the complete documentation index at: https://developers.bonifiq.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# APIs Públicas

> As APIs públicas permitem que você faça chamadas diretamente do navegador (pelo frontend)

É 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.

## Autenticação

Para fazer chamadas para essa API você precisa de um Token Público de API.
Você pode gerar o token no painel administrativo da BonifiQ, no menu API > + CREDENCIAL > Pública.

Após gerar o Token você precisa passá-lo pelo cabeçalho http X-BQ-ApiToken em todas as requisições.

Como exemplo, para usá-lo em uma chamada fetch do Java Script você faria:

```
fetch('https://api.bonifiq.com.br/v1/pub/customer/1/points', {
        method: 'GET',
        headers: {
            'X-BQ-APITOKEN': 'YOUR_API_TOKEN'
        },
    }).then(response => response.json()).then(response => console.log(response))
```

## Endpoint

O endpoint base para todas as chamadas da API pública é:
`https://api.bonifiq.com.br/v1/pub/`

Se for necessário um ambiente de sandbox, solicite a criação de um ambiente de testes.

## Swagger

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

[https://api.bonifiq.com.br/apidocs/public/](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