Usar o Security Scheme

Configurando Security Schemes no nível da pasta

Selecione qualquer pasta, clique na aba Auth à direita e escolha Security Scheme como o tipo de autenticação.

Escolhendo o tipo de autenticação security scheme

Selecione o Security Scheme desejado no menu suspenso.

Se você escolher OAuth 2.0 como security scheme, poderá selecionar também os Scopes necessários.

Selecionando o escopo do security scheme

Security schemes configurados no nível da pasta serão aplicados a todas as subpastas e endpoints dentro dessa pasta, a menos que eles tenham sua própria configuração de autenticação.

Configurando Security Schemes no nível do endpoint

Selecione qualquer endpoint e acesse a aba Edit à direita. Na seção Request, escolha Security Scheme como o tipo de autorização.

Configurando security scheme no nível do endpoint

Selecione o Security Scheme desejado no menu suspenso.

Selecionando o security scheme desejado para o endpoint

Se você escolher OAuth 2.0 como security scheme, poderá selecionar também os Scopes necessários.

Selecionando o escopo do security scheme do endpoint

As configurações de autenticação definidas no nível do endpoint substituirão aquelas definidas no nível da pasta.

Definindo valores padrão para Security Scheme

Security scheme define apenas o método de autenticação. Você ainda precisa fornecer os valores reais de autenticação ao depurar endpoints.

Para evitar preencher repetidamente os valores de autenticação durante a depuração de endpoints, o Apidog permite que você defina valores padrão de autenticação. Depois de definidos, esses padrões são usados automaticamente durante a depuração, a menos que sejam substituídos manualmente. Se uma pasta tiver valores padrão de autenticação configurados, todos os endpoints dentro dela poderão usá-los.

Escolha um security scheme na lista e defina Default Auth Values.

Preencha os valores com base no tipo de autenticação:

API Key: Insira sua chave

Basic Auth: Insira nome de usuário e senha

Bearer Token: Insira o token

OAuth 2.0: Insira o ID do cliente, o segredo do cliente etc.

Outros métodos: Preencha os valores correspondentes

Herdando e personalizando valores de autenticação

Ao usar security scheme, você pode:

1. Herdar da pasta pai

Usar o security scheme e os valores padrão definidos na pasta pai ou raiz.

2. Personalizar valores de autenticação

Manter o mesmo security scheme, mas substituir seus valores padrão.

Usando vários Security Schemes

O Apidog permite configurar vários security schemes para um único endpoint, o que está alinhado aos mecanismos de vários tipos de autenticação definidos na especificação OpenAPI:

AND: Security schemes combinados via AND devem ser usados simultaneamente na mesma requisição (em breve).

OR: Security schemes combinados via OR são alternativas — qualquer um deles pode ser usado no contexto fornecido.

Use o botão + nas configurações de Auth para adicionar mais security schemes.

Escolhendo Scopes para OAuth 2.0 Security Scheme

De acordo com a especificação OpenAPI, ao criar um OAuth 2.0 security scheme, todos os Scopes possíveis devem ser definidos. Ao usá-lo em um endpoint, você deve selecionar os escopos necessários.

Para facilitar, o Apidog permite que você defina escopos padrão no nível da pasta. Esses padrões serão aplicados a todos os endpoints na pasta — a menos que você defina manualmente escopos diferentes no nível do endpoint.

Nas configurações de Auth do endpoint, selecione OAuth 2.0.

Na seção Scopes, você pode visualizar todos os escopos disponíveis definidos pelo security scheme e selecionar os necessários.

Escolher escopos de autenticação no nível do endpoint

Se o endpoint herdar escopos de uma pasta pai, você poderá clicar em Reset the scopes to the configuration of the parent folder para reverter para a configuração da pasta pai.

Depurando endpoints com OAuth 2.0 Security Scheme

Você pode pré-configurar um token como valor padrão para OAuth 2.0 security scheme, para não precisar obter um novo token toda vez que depurar uma API.

Obtendo um token no nível da pasta como valor padrão de autenticação

Selecione uma pasta, acesse a aba Auth, escolha um OAuth 2.0 security scheme, selecione escopos e o tipo de concessão e clique em Get Token.

No painel pop-up:

Insira o ID do cliente, o segredo do cliente etc.

Clique em Continue

Testar security scheme de token OAuth 2.0

Depois de obter o token, você poderá visualizar seus detalhes, incluindo quando ele expira. Esse token pode ser usado em todos os endpoints da pasta.

Obtendo um token no nível do endpoint como valor padrão de autenticação

Selecione o endpoint desejado, acesse Edit, escolha um OAuth 2.0 security scheme e clique em Get Token.

No painel pop-up:

Insira o ID do cliente, o segredo do cliente etc.

Clique em Continue

Testar security scheme de token OAuth 2.0 no nível do endpoint

Conclua a autorização para obter um token

O token será usado para depurar este endpoint

Usando um token padrão ou gerando um novo para depuração de endpoint

Ao depurar um endpoint no Apidog, você tem duas opções para aplicar um token de autenticação:

Método 1: Usar um token de autenticação padrão

Ao executar um endpoint, acesse a aba Auth no painel Run. Selecione Use Parent Default Auth Values. O token de autenticação padrão configurado na pasta pai será aplicado automaticamente à requisição do endpoint.

Usar um token de autenticação padrão para depuração de endpoint

Método 2: Gerar um novo token

Ao executar um endpoint, acesse a aba Auth no painel Run. Selecione Set Manually. Clique em Get Token para abrir o painel de geração de token.

Gerar um novo token para depuração de endpoint

No painel pop-up:

Insira o ID do cliente, o segredo do cliente etc.

Clique em Continue

Preencher informações para gerar um novo token

Conclua a autorização para obter um token

O token será usado para depurar o endpoint atual

Usar o Security Scheme

Configurando Security Schemes no nível da pasta#

Configurando Security Schemes no nível do endpoint#

Definindo valores padrão para Security Scheme#

Herdando e personalizando valores de autenticação#

1. Herdar da pasta pai#

2. Personalizar valores de autenticação#

Usando vários Security Schemes#

Escolhendo Scopes para OAuth 2.0 Security Scheme#

Depurando endpoints com OAuth 2.0 Security Scheme#

Obtendo um token no nível da pasta como valor padrão de autenticação#

Obtendo um token no nível do endpoint como valor padrão de autenticação#

Usando um token padrão ou gerando um novo para depuração de endpoint#

Método 1: Usar um token de autenticação padrão#

Método 2: Gerar um novo token#

Configurando Security Schemes no nível da pasta

Configurando Security Schemes no nível do endpoint

Definindo valores padrão para Security Scheme

Herdando e personalizando valores de autenticação

1. Herdar da pasta pai

2. Personalizar valores de autenticação

Usando vários Security Schemes

Escolhendo Scopes para OAuth 2.0 Security Scheme

Depurando endpoints com OAuth 2.0 Security Scheme

Obtendo um token no nível da pasta como valor padrão de autenticação

Obtendo um token no nível do endpoint como valor padrão de autenticação

Usando um token padrão ou gerando um novo para depuração de endpoint

Método 1: Usar um token de autenticação padrão

Método 2: Gerar um novo token