Autenticação

Todas as chamadas à API do LBHM Utils são autenticadas por uma chave de API. A chave é pessoal e identifica a sua integração — trate-a como uma senha e nunca a exponha em páginas públicas, repositórios ou aplicativos no navegador.

Como enviar a chave

Envie a chave no cabeçalho HTTP Authorization, no formato Bearer:

Authorization: Bearer SUA_CHAVE_DE_API

Exemplo com curl:

curl -H "Authorization: Bearer SUA_CHAVE_DE_API" \
  https://utils.lbhm.com.br/api/v1/cep/01001000

Como obter uma chave

A chave de API é fornecida pela equipe da LBHM para a sua integração. Solicite o acesso ao seu contato na LBHM informando para qual sistema/uso ela será utilizada.

Erros de autenticação

Situação Status HTTP
Cabeçalho Authorization ausente 401 Unauthorized
Chave de API inválida ou revogada 401 Unauthorized

Resposta de exemplo para uma chave ausente ou inválida:

{
  "error": "unauthorized"
}