Autenticação

Referência de autenticação para a API ixblix.

Autenticação por Chave de API

Todos os endpoints no escopo da empresa requerem o header X-API-Key:

Header
X-API-Key: smci_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Obtendo uma Chave de API

Chaves de API são geradas durante a ativação da empresa. Veja Registro de Empresa.

Autenticação de Integrador

Endpoints no escopo do integrador usam HTTP Basic Auth com integratorId e accessToken:

cURL
curl https://api.ixblix.app/api/plans \
  -u "int_xxxx:ixblix_integrator_token_xxxx"

Autenticação do Contato (Cliente)

Endpoints para o cliente usam o token da conversa (do deeplink) ao invés de uma chave de API. Nenhum header de autenticação é necessário — o token é incluído no corpo da requisição ou na URL.

Recomendações de Segurança

  • Armazene chaves de API em um gerenciador de segredos seguro, nunca no controle de versão.
  • Rotacione chaves se forem expostas.
  • Use HTTPS para todas as requisições.
  • A chave de API concede acesso a todos os recursos da empresa; trate-a como uma senha.

Erros de Autenticação

StatusCódigoSignificado
401UNAUTHORIZEDChave de API ausente ou inválida.
403FORBIDDENEmpresa existe mas não está ativa.