Pular para o conteúdo

Autenticação

Envie a chave no cabeçalho x-api-key em todas as requisições. Sem o cabeçalho, ou com uma chave inválida ou revogada, a API responde 401 e não cobra.

Você gera e revoga chaves no painel. Uma chave revogada deixa de funcionar na hora.

Cuidados com a chave

  • Use a chave apenas no seu servidor. Nunca a coloque em código de navegador, aplicativo móvel ou repositório.
  • Crie uma chave por sistema e use chaves de sandbox para testes, para revogar uma sem afetar as outras.
  • Se suspeitar de vazamento, revogue a chave no painel e gere outra.

HTTP

1GET /v1/me HTTP/1.12Host: api.brazid.com3x-api-key: brz_live_••••••••••••••••

401 Unauthorized

1{2 "error": "Invalid or missing API key"3}