Utilizar o Esquema de Segurança

Configurar Esquemas de Segurança ao Nível da Pasta

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

Escolher o tipo de autenticação por esquema de segurança

Selecione o Security Scheme pretendido no menu pendente.

Selecionar o esquema de segurança pretendido

Se escolher OAuth 2.0 como esquema de segurança, pode ainda selecionar os Scopes necessários.

Selecionar o scope do esquema de segurança

Os esquemas de segurança configurados ao nível da pasta serão aplicados a todas as subpastas e endpoints nessa pasta, a menos que tenham a sua própria configuração de autenticação.

Configurar Esquemas de Segurança ao Nível do Endpoint

Selecione qualquer endpoint e aceda ao separador Edit à direita. Na secção Request, escolha Security Scheme como o tipo de autorização.

Configurar o esquema de segurança ao nível do endpoint

Selecione o Security Scheme pretendido no menu pendente.

Selecionar o esquema de segurança pretendido para o endpoint

Se escolher OAuth 2.0 como esquema de segurança, pode ainda selecionar os Scopes necessários.

Selecionar o scope do esquema de segurança do endpoint

As definições de autenticação configuradas ao nível do endpoint substituem as definições ao nível da pasta.

Definir Valores Predefinidos para o Esquema de Segurança

O esquema de segurança define apenas o método de autenticação. Continua a ser necessário 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 definir valores de autenticação predefinidos. Depois de definidos, estes valores predefinidos são utilizados automaticamente durante a depuração, a menos que sejam substituídos manualmente. Se uma pasta tiver valores de autenticação predefinidos configurados, todos os endpoints nela contidos podem utilizá-los.

Escolha um esquema de segurança na lista e defina Default Auth Values.

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

API Key: Introduza a sua chave

Basic Auth: Introduza o nome de utilizador e a palavra-passe

Bearer Token: Introduza o token

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

Outros métodos: Preencha os valores correspondentes

Herdar e Personalizar Valores de Autenticação

Ao utilizar o esquema de segurança, pode:

1. Herdar da Pasta Principal

Utilizar o esquema de segurança e os valores predefinidos definidos na pasta principal ou na pasta raiz.

2. Personalizar Valores de Autenticação

Manter o mesmo esquema de segurança, mas substituir os respetivos valores predefinidos.

Utilizar Vários Esquemas de Segurança

O Apidog suporta a configuração de vários esquemas de segurança para um único endpoint, o que está alinhado com os mecanismos de múltiplos tipos de autenticação definidos na especificação OpenAPI:

AND: Os esquemas de segurança combinados através de AND devem ser utilizados simultaneamente no mesmo pedido (disponível em breve).

OR: Os esquemas de segurança combinados através de OR são alternativas — qualquer um pode ser utilizado no contexto indicado.

Utilize o botão + nas definições de Auth para adicionar mais esquemas de segurança.

Escolher Scopes para o Esquema de Segurança OAuth 2.0

De acordo com a especificação OpenAPI, ao criar um esquema de segurança OAuth 2.0, todos os Scopes possíveis devem ser definidos. Ao utilizá-lo num endpoint, deve selecionar os scopes necessários.

Para simplificar, o Apidog permite definir scopes predefinidos ao nível da pasta. Estes valores predefinidos serão aplicados a todos os endpoints na pasta — a menos que defina manualmente scopes diferentes ao nível do endpoint.

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

Na secção Scopes, pode ver todos os scopes disponíveis definidos pelo esquema de segurança e selecionar os necessários.

Escolher scopes de autenticação ao nível do endpoint

Se o endpoint herdar scopes de uma pasta principal, pode clicar em Reset the scopes to the configuration of the parent folder para reverter para a configuração da pasta principal.

Depurar Endpoints com o Esquema de Segurança OAuth 2.0

Pode pré-configurar um token como valor predefinido para o esquema de segurança OAuth 2.0, para que não tenha de obter um novo token sempre que depurar uma API.

Obter Token ao Nível da Pasta como Valor de Autenticação Predefinido

Selecione uma pasta, aceda ao separador Auth, escolha um esquema de segurança OAuth 2.0, selecione os scopes e o tipo de concessão e, em seguida, clique em Get Token.

No painel pop-up:

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

Clique em Continue

Testar esquema de segurança de token OAuth 2.0

Depois de obter o token, pode ver os respetivos detalhes, incluindo quando expira. Este token pode ser utilizado em todos os endpoints na pasta.

Obter Token ao Nível do Endpoint como Valor de Autenticação Predefinido

Selecione o endpoint pretendido, aceda a Edit, escolha um esquema de segurança OAuth 2.0 e clique em Get Token.

No painel pop-up:

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

Clique em Continue

Testar esquema de segurança de token OAuth 2.0 ao nível do endpoint

Conclua a autorização para obter um token

O token será utilizado para depurar este endpoint

Utilizar um Token Predefinido ou Gerar um Novo para Depuração de Endpoints

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

Método 1: Utilizar um Token de Autenticação Predefinido

Ao executar um endpoint, aceda ao separador Auth no painel Run. Selecione Use Parent Default Auth Values. O token de autenticação predefinido configurado na pasta principal será aplicado automaticamente ao pedido do endpoint.

Utilizar um token de autenticação predefinido para depuração de endpoints

Método 2: Gerar um Novo Token

Ao executar um endpoint, aceda ao separador Auth no painel Run. Selecione Set Manually. Clique em Get Token para abrir o painel de geração de tokens.

Gerar um novo token para depuração de endpoints

No painel pop-up:

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

Clique em Continue

Preencher informações para gerar novo token

Conclua a autorização para obter um token

O token será utilizado para depurar o endpoint atual

Utilizar o Esquema de Segurança

Configurar Esquemas de Segurança ao Nível da Pasta#

Configurar Esquemas de Segurança ao Nível do Endpoint#

Definir Valores Predefinidos para o Esquema de Segurança#

Herdar e Personalizar Valores de Autenticação#

1. Herdar da Pasta Principal#

2. Personalizar Valores de Autenticação#

Utilizar Vários Esquemas de Segurança#

Escolher Scopes para o Esquema de Segurança OAuth 2.0#

Depurar Endpoints com o Esquema de Segurança OAuth 2.0#

Obter Token ao Nível da Pasta como Valor de Autenticação Predefinido#

Obter Token ao Nível do Endpoint como Valor de Autenticação Predefinido#

Utilizar um Token Predefinido ou Gerar um Novo para Depuração de Endpoints#

Método 1: Utilizar um Token de Autenticação Predefinido#

Método 2: Gerar um Novo Token#

Configurar Esquemas de Segurança ao Nível da Pasta

Configurar Esquemas de Segurança ao Nível do Endpoint

Definir Valores Predefinidos para o Esquema de Segurança

Herdar e Personalizar Valores de Autenticação

1. Herdar da Pasta Principal

2. Personalizar Valores de Autenticação

Utilizar Vários Esquemas de Segurança

Escolher Scopes para o Esquema de Segurança OAuth 2.0

Depurar Endpoints com o Esquema de Segurança OAuth 2.0

Obter Token ao Nível da Pasta como Valor de Autenticação Predefinido

Obter Token ao Nível do Endpoint como Valor de Autenticação Predefinido

Utilizar um Token Predefinido ou Gerar um Novo para Depuração de Endpoints

Método 1: Utilizar um Token de Autenticação Predefinido

Método 2: Gerar um Novo Token