Gestão do Estado de Autenticação

A autenticação é um aspeto crucial dos testes e do desenvolvimento de APIs. Gerir corretamente o estado de autenticação garante que os seus pedidos de API são seguros, eficientes e refletem com precisão cenários de utilização reais.

Este guia demonstra como gerir eficazmente o estado de autenticação no Apidog, abrangendo métodos de autenticação comuns e a implementação de início de sessão automático.

Métodos de Autenticação Comuns

1. Autenticação por Sessão/Cookie

O Apidog mantém automaticamente o estado de autenticação através de sessões e cookies.

Como funciona:

Após a execução da API de início de sessão, o Apidog guarda globalmente as informações de Sessão/Cookie devolvidas

As chamadas de API subsequentes incluem automaticamente estas informações de Sessão/Cookie

Não é necessária configuração manual para cada pedido

Consulte a secção Implementação de Início de Sessão Automático para obter detalhes sobre como obter início de sessão automático através de Sessão/Cookie.

2. Autenticação Baseada em Token

A autenticação baseada em token envolve a inclusão de credenciais de início de sessão nos parâmetros do pedido de API, normalmente no cabeçalho. As abordagens comuns incluem Basic Auth, Bearer Token e API Key.

Opções de implementação:

Opção 1: Configurar a Autenticação Globalmente

Defina as informações de autenticação em diferentes níveis:

Nível do projeto: Página de visão geral do projeto

Nível do grupo: Definições do grupo

Nível de API individual: Página de documentação

Tipos de autenticação suportados:

Basic Auth

Bearer Token

API Key

OAuth 2.0

E mais

Opção 2: Configuração Manual do Token

Adicione manualmente o token ao cabeçalho ou a outros parâmetros relevantes. Recomendamos a utilização de variáveis de ambiente para armazenar o token.

Exemplos:

Bearer Token: Defina um cabeçalho chamado Authorization com o valor Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9yJpZCI6

Utilizando variáveis de ambiente: Bearer {{AUTH_TOKEN}}

Opção 3: Parâmetros Globais

Defina o valor nos parâmetros globais. Todas as APIs incluirão automaticamente os parâmetros globais durante o tempo de execução, eliminando a necessidade de configuração manual por API.

Consulte a secção Implementação de Início de Sessão Automático para obter detalhes sobre como obter início de sessão automático através de tokens.

3. Método de Início de Sessão Automático

Este método invoca automaticamente a API de início de sessão para concluir a autenticação sem intervenção manual, mantendo o estado de autenticação entre pedidos.

Implementação de Início de Sessão Automático

Resultado Pretendido

Invocação automática da API de início de sessão sem intervenção manual

Preservação do estado de autenticação após um início de sessão bem-sucedido para evitar chamadas redundantes à API de início de sessão

Atualização do token quando as credenciais expiram

Passos de Implementação

Passo 1: Configurar variáveis de ambiente

Utilize variáveis de ambiente para armazenar credenciais de autenticação:

ACCESS_TOKEN: Armazena as credenciais de início de sessão

ACCESS_TOKEN_EXPIRES: Armazena a hora de expiração (se aplicável)

Passo 2: Criar um script público

O script deve:

Verificar se ACCESS_TOKEN tem um valor e se ACCESS_TOKEN_EXPIRES ainda é válido

Se for válido, prosseguir com o pedido

Se for inválido ou estiver em falta, continuar para o passo seguinte

Utilizar pm.sendRequest para chamar a API de início de sessão

Escrever as credenciais devolvidas e a hora de expiração nas variáveis de ambiente

Passo 3: Configurar APIs que requerem autenticação

Para cada API que requer autenticação:

Defina o parâmetro de autenticação como {{ACCESS_TOKEN}}

Defina o cabeçalho Authorization como {{ACCESS_TOKEN}}

Ou utilize cookies/outros parâmetros conforme necessário

Em alternativa, defina o valor nos parâmetros globais para inclusão automática em todas as chamadas de API

Referencie o script público no script de pré-processador

Exemplo de Script Público

Notas importantes:

As credenciais de início de sessão neste script são obtidas a partir das variáveis de ambiente LOGIN_USERNAME e LOGIN_PASSWORD. Certifique-se de que estas estão definidas antes de utilizar este código.

Se o seu token não expirar, remova o código relacionado com ACCESS_TOKEN_EXPIRES.

Ajuste a estrutura do pedido de início de sessão e o tratamento da resposta de acordo com os requisitos específicos da sua API.

Recursos Adicionais

Documentação de pm.sendRequest

Documentação de pm.cookies

Gestão do Estado de Autenticação

Métodos de Autenticação Comuns#

1. Autenticação por Sessão/Cookie#

2. Autenticação Baseada em Token#

Opção 1: Configurar a Autenticação Globalmente#

Opção 2: Configuração Manual do Token#

Opção 3: Parâmetros Globais#

3. Método de Início de Sessão Automático#

Implementação de Início de Sessão Automático#

Resultado Pretendido#

Passos de Implementação#

Exemplo de Script Público#

Recursos Adicionais#

Métodos de Autenticação Comuns

1. Autenticação por Sessão/Cookie

2. Autenticação Baseada em Token

Opção 1: Configurar a Autenticação Globalmente

Opção 2: Configuração Manual do Token

Opção 3: Parâmetros Globais

3. Método de Início de Sessão Automático

Implementação de Início de Sessão Automático

Resultado Pretendido

Passos de Implementação

Exemplo de Script Público

Recursos Adicionais