Visão geral#
A autenticação é obrigatória para todas as requisições feitas às APIs do Portal do Desenvolvedor.O objetivo deste mecanismo é garantir que somente clientes autorizados consigam acessar os recursos disponíveis.A autenticação da API é realizada em duas camadas:1.
Basic Auth - o cliente deve enviar as credenciais de acesso (usuário e senha) codificadas em Base64 no cabeçalho Authorization.
2.
API Key - uma chave de aplicação única que deve ser enviada em conjunto com a requisição, também via cabeçalho.
⚠️ Ambas as credenciais são obrigatórias em todas as chamadas.
Exemplo de Cabeçalhos#
Authorization: Basic dXN1YXJpbzpwYXNzd29yZA==
x-api-key: 1234567890abcdef1234567890abcdef⚠️ O valor após Basic é o resultado da codificação Base64 de usuario:senha
Como funciona o processo de autenticação#
1.
O cliente obtém as credenciais de acesso (usuário, senha e API Key).
2.
A cada requisição à API, o cliente envia:O cabeçalho Authorization: Basic <credenciais_base64>
O cabeçalho x-api-key: <sua_api_key>
3.
A API valida ambos os valores antes de processar a requisição.
4.
Se a autenticação for bem-sucedida, o recurso solicitado é retornado.
Respostas em caso de erro#
| Código | Motivo | Descrição |
|---|
| 401 Unauthorized | Credenciais inválidas | Usuário e/ou senha incorretos, ou formato do header inválido. |
| 403 Forbidden | API Key ausente ou inválida | A chave informada não é reconhecida ou não possui permissão. |
| 429 Too Many Requests | Limite de requisições excedido | O cliente atingiu o limite definido no plano de uso. |
Boas práticas#
Nunca exponha suas credenciais (usuário, senha ou API Key) em código público.
Renove periodicamente suas credenciais de autenticação.
Utilize variáveis de ambiente para armazenar dados sensíveis.
Em caso de revogação ou suspeita de uso indevido, solicite uma nova API Key imediatamente.
Modificado em 2025-12-05 12:14:35
