Gestión del estado de autenticación

La autenticación es un aspecto crucial de las pruebas y el desarrollo de API. Gestionar correctamente el estado de autenticación garantiza que sus peticiones de API sean seguras, eficientes y reflejen con precisión escenarios de uso reales.

Esta guía demuestra cómo gestionar eficazmente el estado de autenticación en Apidog, cubriendo métodos de autenticación comunes y la implementación del inicio de sesión automático.

Métodos de autenticación comunes

1. Autenticación mediante sesión/cookie

Apidog mantiene automáticamente el estado de autenticación mediante sesiones y cookies.

Cómo funciona:

Al ejecutar la API de inicio de sesión, Apidog guarda globalmente la información de Session/Cookie devuelta

Las llamadas posteriores a la API incluyen automáticamente esta información de Session/Cookie

No se requiere configuración manual para cada petición

Consulte la sección Implementación del inicio de sesión automático para obtener detalles sobre cómo lograr el inicio de sesión automático mediante Session/Cookie.

2. Autenticación basada en tokens

La autenticación basada en tokens implica incluir credenciales de inicio de sesión en los parámetros de la petición de API, normalmente en el encabezado. Los enfoques comunes incluyen Basic Auth, Bearer Token y API Key.

Opciones de implementación:

Opción 1: Configurar la autenticación globalmente

Establezca la información de autenticación en distintos niveles:

Nivel de proyecto: Página de descripción general del proyecto

Nivel de grupo: Configuración del grupo

Nivel de API individual: Página de documentación

Tipos de autenticación admitidos:

Basic Auth

Bearer Token

API Key

OAuth 2.0

Y más

Opción 2: Configuración manual del token

Añada manualmente el token al encabezado u otros parámetros relevantes. Recomendamos utilizar variables de entorno para almacenar el token.

Ejemplos:

Bearer Token: Establezca un encabezado llamado Authorization con el valor Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9yJpZCI6

Uso de variables de entorno: Bearer {{AUTH_TOKEN}}

Opción 3: Parámetros globales

Establezca el valor en los parámetros globales. Todas las API incluirán automáticamente los parámetros globales durante el tiempo de ejecución, lo que elimina la necesidad de configuración manual por API.

Consulte la sección Implementación del inicio de sesión automático para obtener detalles sobre cómo lograr el inicio de sesión automático mediante tokens.

3. Método de inicio de sesión automático

Este método invoca automáticamente la API de inicio de sesión para completar la autenticación sin intervención manual, manteniendo el estado de autenticación entre peticiones.

Implementación del inicio de sesión automático

Resultado deseado

Invocación automática de la API de inicio de sesión sin intervención manual

Conservación del estado de autenticación después de un inicio de sesión correcto para evitar llamadas redundantes a la API de inicio de sesión

Actualización del token cuando las credenciales caduquen

Pasos de implementación

Paso 1: Configurar variables de entorno

Utilice variables de entorno para almacenar credenciales de autenticación:

ACCESS_TOKEN: Almacena las credenciales de inicio de sesión

ACCESS_TOKEN_EXPIRES: Almacena la hora de caducidad (si corresponde)

Paso 2: Crear un script público

El script debe:

Comprobar si ACCESS_TOKEN tiene un valor y si ACCESS_TOKEN_EXPIRES sigue siendo válido

Si es válido, continuar con la petición

Si no es válido o falta, continuar con el siguiente paso

Utilizar pm.sendRequest para llamar a la API de inicio de sesión

Escribir las credenciales devueltas y la hora de caducidad en variables de entorno

Paso 3: Configurar las API que requieren autenticación

Para cada API que requiera autenticación:

Establezca el parámetro de autenticación en {{ACCESS_TOKEN}}

Establezca el encabezado Authorization en {{ACCESS_TOKEN}}

O utilice cookies/otros parámetros según sea necesario

Como alternativa, establezca el valor en parámetros globales para su inclusión automática en todas las llamadas a la API

Haga referencia al script público en el script de preprocesador

Ejemplo de script público

Notas importantes:

Las credenciales de inicio de sesión en este script se obtienen de las variables de entorno LOGIN_USERNAME y LOGIN_PASSWORD. Asegúrese de que estén configuradas antes de utilizar este código.

Si su token no caduca, elimine el código relacionado con ACCESS_TOKEN_EXPIRES.

Ajuste la estructura de la petición de inicio de sesión y el manejo de la respuesta según los requisitos específicos de su API.

Recursos adicionales

pm.sendRequest documentation

pm.cookies documentation

Gestión del estado de autenticación

Métodos de autenticación comunes#

1. Autenticación mediante sesión/cookie#

2. Autenticación basada en tokens#

Opción 1: Configurar la autenticación globalmente#

Opción 2: Configuración manual del token#

Opción 3: Parámetros globales#

3. Método de inicio de sesión automático#

Implementación del inicio de sesión automático#

Resultado deseado#

Pasos de implementación#

Ejemplo de script público#

Recursos adicionales#

Métodos de autenticación comunes

1. Autenticación mediante sesión/cookie

2. Autenticación basada en tokens

Opción 1: Configurar la autenticación globalmente

Opción 2: Configuración manual del token

Opción 3: Parámetros globales

3. Método de inicio de sesión automático

Implementación del inicio de sesión automático

Resultado deseado

Pasos de implementación

Ejemplo de script público

Recursos adicionales