O Apidog oferece vários métodos de autenticação para pedidos de API, permitindo-lhe proteger as suas integrações e aceder a recursos protegidos. Esta página fornece uma referência abrangente de todos os tipos de autorização suportados e de como configurá-los no Apidog.Pode selecionar um tipo de autenticação no menu Type na secção Authorization de um pedido. A autenticação pode ser aplicada ao nível do pedido, da pasta ou da coleção, proporcionando flexibilidade na forma como gere credenciais no seu espaço de trabalho de API.
"Herdar do elemento principal" é o tipo de autenticação predefinido no Apidog. Quando o tipo de autenticação de um pedido está definido como "Herdar do elemento principal", este herdará a configuração de autenticação da respetiva pasta principal e continuará a herdar até à pasta raiz. Isto permite-lhe configurar a autenticação uma única vez ao nível da pasta e aplicá-la automaticamente a todos os pedidos secundários.
Benefícios:
Gestão centralizada da autenticação
Atualizações de credenciais mais simples
Autenticação consistente entre pedidos relacionados
Se não for necessária autenticação, o Apidog não incluirá quaisquer detalhes de autorização. Basta escolher No Auth no menu pendente Type no separador Authorization para pedidos não autenticados.Quando utilizar:
Endpoints de API públicos
Endpoints de verificação de estado
Endpoints que tratam a autenticação de formas personalizadas
Para autenticação por chave de API, fornece um par chave-valor nos cabeçalhos do pedido ou nos parâmetros de consulta. Selecione API Key nas opções de Type, introduza o nome e o valor da sua chave e escolha adicioná-la a Headers ou Query Params.
O Apidog acrescentará automaticamente as informações necessárias aos cabeçalhos do seu pedido ou à cadeia de consulta do URL.
Melhor prática de segurança
Para maior segurança, armazene as chaves de API em variáveis de ambiente em vez de as codificar diretamente nos pedidos. Isto evita a exposição acidental no controlo de versões ou em espaços de trabalho partilhados.
A autenticação por bearer token, como JSON Web Tokens (JWT), utiliza uma chave de acesso no cabeçalho do pedido. Escolha Bearer Token na lista Type e introduza a 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 que não sejam "Bearer", utilize a opção API Key com "Authorization" como nome da chave.
A autenticação básica envolve o envio de credenciais verificadas com o seu pedido. Selecione Basic Auth no menu Type e introduza o seu nome de utilizador e palavra-passe da API.O Apidog incluirá um cabeçalho Authorization com uma cadeia codificada em Base64 das suas credenciais neste formato:
Basic <Base64 encoded username and password>
Limitação de segurança
O Basic Auth transmite credenciais em codificação Base64, que é facilmente descodificada. Utilize sempre HTTPS ao usar Basic Auth e considere alternativas mais seguras, como OAuth 2.0, para ambientes de produção.
