Autenticação

Obtendo sua Chave de API

A API do Belasis requer o uso de uma chave de autenticação. Para gerar a sua chave, siga estas etapas:

Acesse seu painel Belasis
Navegue até a seção Configurações → API
Clique em Gerar token
Copie a chave exibida e salve-a em local seguro

📘
Recuperação de chave
Você conseguirá recuperar sua chave de acesso voltando nesta mesma seção e clicando em Visualizar Chave.

❗
NÃO COMPARTILHE SUA CHAVE DE API
A chave de API é secreta, pessoal e intransferível. Com ela, é possível acessar dados e realizar operações em todos os seus estabelecimentos, portanto, não compartilhe-a com terceiros.

Autenticação com ApiKey

Nossa API usa o modelo de autenticação do tipo ApiKey. Tendo-a em mãos, basta apenas montar suas requisições HTTP contendo sua chave no header da seguinte maneira:

Key: ACCESS-TOKEN

Value: bpk_SuaChaveAqui

Formato da Chave

Todas as chaves de API começam com o prefixo bpk_ seguido de uma sequência única de caracteres.

Exemplo: bpk_1a2b3c4d5e6f7g8h9i0j

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

{
  "Content-Type": "application/json",
  "ACCESS-TOKEN": "bpk_sua_chave_aqui"
}

Códigos de Resposta de Autenticação

Código	Descrição
`200 OK`	Autenticação bem-sucedida e requisição processada
`401 Unauthorized`	Chave de API inválida, não informada ou conta sem permissão
`429 Too Many Requests`	Limite de requisições excedido (30 por minuto)

Erros Comuns de Autenticação

Este erro ocorre quando:

A chave de API não foi fornecida no header ACCESS-TOKEN
A chave fornecida é inválida ou não existe
A chave não começa com o prefixo bpk_
Sua conta não possui o recurso de API ativo
A chave foi revogada

Solução:

Verifique se o header ACCESS-TOKEN está sendo enviado corretamente
Confirme que sua chave começa com bpk_
Certifique-se de que o recurso de API está ativo em sua conta
Se necessário, gere uma nova chave no painel

Revogação e Renovação de Chave

Se sua chave foi comprometida ou você suspeita de uso indevido:

Acesse Configurações → API
Clique em Gerar token
Atualize todas as suas integrações com a nova chave

⚠️
Importante
Ao revogar uma chave, todas as integrações que a utilizam deixarão de funcionar imediatamente.