Gerenciamento do Estado de Autenticação

A autenticação é um aspecto crucial dos testes e do desenvolvimento de APIs. Gerenciar adequadamente o estado de autenticação garante que suas requisições de API sejam seguras, eficientes e reflitam com precisão cenários de uso do mundo real.

Este guia demonstra como lidar de forma eficaz com o estado de autenticação no Apidog, abrangendo métodos comuns de autenticação e a implementação de login automático.

Métodos Comuns de Autenticação

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

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

Como funciona:

Após a execução da API de login, o Apidog salva globalmente as informações de Sessão/Cookie retornadas

Chamadas de API subsequentes incluem automaticamente essas informações de Sessão/Cookie

Nenhuma configuração manual é necessária para cada requisição

Consulte a seção Implementação de Login Automático para obter detalhes sobre como realizar login automático via Sessão/Cookie.

2. Autenticação Baseada em Token

A autenticação baseada em token envolve incluir credenciais de login nos parâmetros da requisição de API, normalmente no Cabeçalho. 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: Configurações do grupo

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

Tipos de autenticação compatíveis:

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 usar variáveis de ambiente para armazenamento do token.

Exemplos:

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

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

Opção 3: Parâmetros Globais

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

Consulte a seção Implementação de Login Automático para obter detalhes sobre como realizar login automático via tokens.

Este método invoca automaticamente a API de login para concluir a autenticação sem intervenção manual, mantendo o estado de autenticação entre requisições.

Resultado Desejado

Invocação automática da API de login sem intervenção manual

Preservação do estado de autenticação após o login bem-sucedido para evitar chamadas redundantes à API de login

Atualização do token quando as credenciais expirarem

Etapas de Implementação

Etapa 1: Configurar variáveis de ambiente

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

ACCESS_TOKEN: Armazena credenciais de login

ACCESS_TOKEN_EXPIRES: Armazena o horário de expiração (se aplicável)

Etapa 2: Criar um script público

O script deve:

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

Se for válido, prosseguir com a requisição

Se for inválido ou estiver ausente, continuar para a próxima etapa

Usar pm.sendRequest para chamar a API de login

Gravar as credenciais retornadas e o horário de expiração nas variáveis de ambiente

Etapa 3: Configurar APIs que exigem autenticação

Para cada API que exige autenticação:

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

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

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

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

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

Exemplo de Script Público

Observações importantes:

As credenciais de login neste script são obtidas das variáveis de ambiente LOGIN_USERNAME e LOGIN_PASSWORD. Certifique-se de que elas estejam definidas antes de usar este código.

Se o seu token não expira, remova o código relacionado a ACCESS_TOKEN_EXPIRES.

Ajuste a estrutura da requisição de login 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

Gerenciamento do Estado de Autenticação

Métodos Comuns de Autenticação#

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 Login Automático#

Implementação de Login Automático#

Resultado Desejado#

Etapas de Implementação#

Exemplo de Script Público#

Recursos Adicionais#

Métodos Comuns de Autenticação

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 Login Automático

Implementação de Login Automático

Resultado Desejado

Etapas de Implementação

Exemplo de Script Público

Recursos Adicionais