Usar el esquema de seguridad

Configurar esquemas de seguridad a nivel de carpeta

Seleccione cualquier carpeta, haga clic en la pestaña Auth de la derecha y elija Security Scheme como tipo de autenticación.

Elegir el tipo de autenticación de esquema de seguridad

Seleccione el Security Scheme deseado en el menú desplegable.

Seleccionar el esquema de seguridad deseado

Si elige OAuth 2.0 como esquema de seguridad, puede seleccionar además los Scopes requeridos.

Seleccionar el scope del esquema de seguridad

Los esquemas de seguridad configurados a nivel de carpeta se aplicarán a todas las subcarpetas y endpoints bajo esa carpeta, a menos que tengan su propia configuración de autenticación.

Configurar esquemas de seguridad a nivel de endpoint

Seleccione cualquier endpoint y vaya a la pestaña Edit de la derecha. En la sección Request, elija Security Scheme como tipo de autorización.

Configurar el esquema de seguridad a nivel de endpoint

Seleccione el Security Scheme deseado en el menú desplegable.

Seleccionar el esquema de seguridad deseado para el endpoint

Si elige OAuth 2.0 como esquema de seguridad, puede seleccionar además los Scopes requeridos.

Seleccionar el scope del esquema de seguridad del endpoint

La configuración de autenticación configurada a nivel de endpoint sobrescribirá la del nivel de carpeta.

Establecer valores predeterminados para el esquema de seguridad

El esquema de seguridad solo define el método de autenticación. Aún debe proporcionar los valores de autenticación reales al depurar endpoints.

Para evitar completar repetidamente los valores de autenticación durante la depuración de endpoints, Apidog le permite establecer valores de autenticación predeterminados. Una vez establecidos, estos valores predeterminados se utilizan automáticamente durante la depuración, a menos que se sobrescriban manualmente. Si una carpeta tiene valores de autenticación predeterminados configurados, todos los endpoints bajo ella pueden utilizarlos.

Elija un esquema de seguridad de la lista y establezca Default Auth Values.

Complete los valores según el tipo de autenticación:

API Key: Introduzca su clave

Basic Auth: Introduzca el nombre de usuario y la contraseña

Bearer Token: Introduzca el token

OAuth 2.0: Introduzca el ID de cliente, el secreto de cliente, etc.

Otros métodos: Complete los valores correspondientes

Heredar y personalizar valores de autenticación

Al usar un esquema de seguridad, puede:

1. Heredar de la carpeta principal

Utilice el esquema de seguridad y los valores predeterminados definidos en la carpeta principal o raíz.

2. Personalizar valores de autenticación

Mantenga el mismo esquema de seguridad, pero sobrescriba sus valores predeterminados.

Usar múltiples esquemas de seguridad

Apidog admite la configuración de múltiples esquemas de seguridad para un único endpoint, lo que se alinea con los mecanismos de múltiples tipos de autenticación definidos en la especificación de OpenAPI:

AND: Los esquemas de seguridad combinados mediante AND deben utilizarse simultáneamente en la misma petición (próximamente).

OR: Los esquemas de seguridad combinados mediante OR son alternativas; cualquiera puede utilizarse en el contexto dado.

Use el botón + en la configuración de Auth para agregar más esquemas de seguridad.

Elegir scopes para el esquema de seguridad OAuth 2.0

Según la especificación de OpenAPI, al crear un esquema de seguridad OAuth 2.0, se deben definir todos los Scopes posibles. Al utilizarlo en un endpoint, debe seleccionar los scopes requeridos.

Para facilitar las cosas, Apidog le permite establecer scopes predeterminados a nivel de carpeta. Estos valores predeterminados se aplicarán a todos los endpoints de la carpeta, a menos que establezca manualmente scopes diferentes a nivel de endpoint.

En la configuración de Auth del endpoint, seleccione OAuth 2.0.

En la sección Scopes, puede ver todos los scopes disponibles definidos por el esquema de seguridad y seleccionar los necesarios.

Elegir scopes de autenticación a nivel de endpoint

Si el endpoint hereda scopes de una carpeta principal, puede hacer clic en Reset the scopes to the configuration of the parent folder para volver a la configuración principal.

Depurar endpoints con el esquema de seguridad OAuth 2.0

Puede preconfigurar un token como valor predeterminado para el esquema de seguridad OAuth 2.0, de modo que no necesite obtener un token nuevo cada vez que depure una API.

Obtener un token a nivel de carpeta como valor de autenticación predeterminado

Seleccione una carpeta, vaya a la pestaña Auth, elija un esquema de seguridad OAuth 2.0, seleccione scopes y el tipo de concesión, y luego haga clic en Get Token.

Obtener token de OAuth 2.0 a nivel de carpeta

En el panel emergente:

Introduzca el ID de cliente, el secreto de cliente, etc.

Haga clic en Continue

Probar el esquema de seguridad de token OAuth 2.0

Después de obtener el token, puede ver sus detalles, incluido cuándo caduca. Este token puede utilizarse en todos los endpoints de la carpeta.

Obtener un token a nivel de endpoint como valor de autenticación predeterminado

Seleccione el endpoint deseado, vaya a Edit, elija un esquema de seguridad OAuth 2.0 y haga clic en Get Token.

En el panel emergente:

Introduzca el ID de cliente, el secreto de cliente, etc.

Haga clic en Continue

Probar el esquema de seguridad de token OAuth 2.0 a nivel de endpoint

Complete la autorización para obtener un token

El token se utilizará para depurar este endpoint

Usar un token predeterminado o generar uno nuevo para la depuración de endpoints

Al depurar un endpoint en Apidog, tiene dos opciones para aplicar un token de autenticación:

Método 1: Usar un token de autenticación predeterminado

Al ejecutar un endpoint, vaya a la pestaña Auth en el panel Run. Seleccione Use Parent Default Auth Values. El token de autenticación predeterminado configurado en la carpeta principal se aplicará automáticamente a la petición del endpoint.

Usar un token de autenticación predeterminado para la depuración de endpoints

Método 2: Generar un token nuevo

Al ejecutar un endpoint, vaya a la pestaña Auth en el panel Run. Seleccione Set Manually. Haga clic en Get Token para abrir el panel de generación de tokens.

Generar un token nuevo para la depuración de endpoints

En el panel emergente:

Introduzca el ID de cliente, el secreto de cliente, etc.

Haga clic en Continue

Completar información para generar un token nuevo

Complete la autorización para obtener un token

El token se utilizará para depurar el endpoint actual

Usar el esquema de seguridad

Configurar esquemas de seguridad a nivel de carpeta#

Configurar esquemas de seguridad a nivel de endpoint#

Establecer valores predeterminados para el esquema de seguridad#

Heredar y personalizar valores de autenticación#

1. Heredar de la carpeta principal#

2. Personalizar valores de autenticación#

Usar múltiples esquemas de seguridad#

Elegir scopes para el esquema de seguridad OAuth 2.0#

Depurar endpoints con el esquema de seguridad OAuth 2.0#

Obtener un token a nivel de carpeta como valor de autenticación predeterminado#

Obtener un token a nivel de endpoint como valor de autenticación predeterminado#

Usar un token predeterminado o generar uno nuevo para la depuración de endpoints#

Método 1: Usar un token de autenticación predeterminado#

Método 2: Generar un token nuevo#

Configurar esquemas de seguridad a nivel de carpeta

Configurar esquemas de seguridad a nivel de endpoint

Establecer valores predeterminados para el esquema de seguridad

Heredar y personalizar valores de autenticación

1. Heredar de la carpeta principal

2. Personalizar valores de autenticación

Usar múltiples esquemas de seguridad

Elegir scopes para el esquema de seguridad OAuth 2.0

Depurar endpoints con el esquema de seguridad OAuth 2.0

Obtener un token a nivel de carpeta como valor de autenticación predeterminado

Obtener un token a nivel de endpoint como valor de autenticación predeterminado

Usar un token predeterminado o generar uno nuevo para la depuración de endpoints

Método 1: Usar un token de autenticación predeterminado

Método 2: Generar un token nuevo