​
Como é feita a autenticação na API do BitPix?

A autenticação em nossa API é feita através do uso de uma API Key. É através desta chave que nosso sistema identifica a sua conta e permite a comunicação conosco em nome da conta em questão.

Caso a chave de API seja inválida, não seja informada ou o header esteja incorreto, nossa API retornará HTTP 401.

​
Utilize os headers abaixo em todas as suas chamadas para a API:

"Content-Type": "application/json",
"Authorization": "Bearer sua_api_key"

​
Dicas importantes:

Após a geração da chave de API em nossa interface, armazene-a diretamente em seu cofre de chaves, evitando que seja exposta em mensagens de qualquer tipo ou emails. Nunca deixe a chave de API diretamente no código fonte de seus sistemas.
Não informe sua chave de API em atendimentos, a terceiros ou exponha no front-end da sua aplicação. Garanta que sua aplicação não exponha a chave em logs de sistema.

​
Como criar uma API Key?

1

Você precisará ter uma conta BitPix

Acesse sua conta BitPix e vá para https://painel.bitpix.app/apikey.

2

Toque em Criar Api Key

3

Preencha as informações

O nome da API Key e o site que ela será utilizada é opcional e servem para te ajudar a organizar, caso use mais que uma chave.

Ao tocar em “Criar API Key” sua chave será criada!

IntroduçãoCódigos HTTP das respostas