Como funcionam as APIs?#
As APIs deste serviço foram organizadas de forma a representar o fluxo operacional típico de um FIDC. Cada rota executa uma etapa específica do processo, e todas seguem um padrão claro para facilitar o entendimento e a integração.Autenticação#
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.
Bearer Token - uma chave de aplicação única que deve ser enviada em conjunto com a requisição, também via cabeçalho.
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: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9
x-api-key: 1234567890abcdef1234567890abcdef⚠️ O valor após Bearer é 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: Bearer <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 | JWT Token Inválido | 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. |
Modificado em 2025-11-24 19:14:47
