Apidog oferece vários métodos de autenticação para requisições de API, permitindo que você proteja suas integrações e acesse recursos protegidos. Esta página fornece uma referência abrangente de todos os tipos de autorização compatíveis e como configurá-los no Apidog.Você pode selecionar um tipo de autenticação no menu Type na seção Authorization de uma requisição. A autenticação pode ser aplicada no nível da requisição, da pasta ou da coleção, oferecendo flexibilidade na forma como você gerencia credenciais em seu workspace de API.
"Inherit from Parent" é o tipo de autenticação padrão no Apidog. Quando o tipo de autenticação de uma requisição está definido como "Inherit from Parent", ela herdará a configuração de autenticação de sua pasta pai e continuará herdando até a pasta raiz. Isso permite que você configure a autenticação uma vez no nível da pasta e a aplique automaticamente a todas as requisições filhas.
Benefícios:
Gerenciamento centralizado de autenticação
Atualizações de credenciais mais fáceis
Autenticação consistente em requisições relacionadas
Se nenhuma autenticação for necessária, o Apidog não incluirá nenhum detalhe de autorização. Basta escolher No Auth no menu suspenso Type na aba Authorization para requisições não autenticadas.Quando usar:
Endpoints de API públicos
Endpoints de verificação de integridade
Endpoints que tratam autenticação de maneiras personalizadas
Para autenticação por chave de API, você fornece um par chave-valor nos cabeçalhos da requisição ou nos parâmetros de consulta. Selecione API Key nas opções de Type, insira o nome e o valor da sua chave e escolha adicioná-la a Headers ou Query Params.
O Apidog anexará automaticamente as informações necessárias aos Headers da sua requisição ou à string de consulta da URL.
Prática recomendada de segurança
Para maior segurança, armazene chaves de API em variáveis de ambiente em vez de codificá-las diretamente nas requisições. Isso evita exposição acidental em controle de versão ou workspaces compartilhados.
A autenticação por bearer token, como JSON Web Tokens (JWT), usa uma chave de acesso no cabeçalho da requisição. Escolha Bearer Token na lista Type e insira sua chave de API no campo Token.O Apidog adicionará o token ao cabeçalho Authorization neste formato:
Bearer <Your API key>
Prefixos personalizados
Para prefixos personalizados diferentes de "Bearer", use a opção API Key com "Authorization" como o nome da chave.
O Apidog também oferece suporte à geração de tokens JWT diretamente dentro da aplicação. Selecione JWT Bearer nas opções de Type.Opções de configuração:
Location: Adicionar token ao Request Header ou Query Param
Algorithm: Escolha entre variantes HS, RS, ES ou PS com SHA
Secret/Key: Insira o segredo ou a chave privada necessária
Payload: Insira os dados do payload em formato JSON
As configurações avançadas permitem configurar prefixos de cabeçalho e cabeçalhos personalizados.
Basic auth envolve o envio de credenciais verificadas com sua requisição. Selecione Basic Auth no menu Type e insira seu nome de usuário e senha da API.O Apidog incluirá um cabeçalho Authorization com uma string codificada em Base64 das suas credenciais neste formato:
Basic <Base64 encoded username and password>
Limitação de segurança
Basic Auth transmite credenciais em codificação Base64, que é facilmente decodificada. Sempre use HTTPS ao usar Basic Auth e considere alternativas mais seguras, como OAuth 2.0, para ambientes de produção.
