Creación, configuración y eliminación de un cliente de la API pública de Vantage

1. En Vantage, haga clic en Configuration.
2. En el cuadro de diálogo Tenant Adminstration, haga clic en Create API Client.

2. Para copiar cada valor, haga clic en el copy icon situado junto a cada uno. Alternativamente, haga clic en Save to File para descargar un archivo TXT que contenga ambos valores.

¡Importante! El valor del secreto solo se muestra una vez durante la creación del cliente, por lo que debe guardarse de inmediato.

3. Haga clic en Close.
   Aparece la página Public API Client.

1. En Vantage, haga clic en Configuration.
2. En el cuadro de diálogo Tenant Adminstration, haga clic en Public API Client.
3. En la página Public API Client, haga clic en la lista desplegable New Client y luego haga clic en Add Client.

4. Para copiar cada valor, haga clic en el icono de copia junto a cada uno. Como alternativa, haga clic en Save to File para descargar un archivo TXT que contiene ambos valores.

Importante: El valor del secreto se muestra solo una vez durante la creación del cliente, por lo que debe guardarse de inmediato.

5. Haga clic en Close.
   Aparece la página Public API Client.

1. En el campo Client Name, introduzca el nombre del nuevo cliente de API pública.

2. Para crear un nuevo secreto, haga clic en Add Secret. De forma predeterminada, se crea un secreto por un período de 6 meses. Puede cambiar el plazo de vencimiento y establecerlo hasta 36 meses.
3. Para agregar una nueva URL de redirección, haga clic en Add Redirect URL.
4. Configure los flujos de autenticación permitidos en la sección OAuth 2.0 Flows Settings.
   Nota: Este flujo no funciona cuando se configura un proveedor de identidad externo.
   Puede seleccionar más de un flujo:
   • Allow Authorization Code Flow. Permite la autenticación utilizando este esquema de autenticación seguro, en el que, en lugar de enrutar la solicitud de autenticación al usuario, la aplicación la envía directamente al servidor de autorización de Vantage. El servidor de autorización verifica entonces las credenciales del usuario y proporciona al cliente un código de autorización. El flujo Authorization Code Flow está habilitado para todos los clientes de Vantage API. Si es necesario:
     • Seleccione la opción Require PKCE for Authorization Code Flow. Esta opción refuerza la seguridad al autorizar clientes públicos. Permite que Vantage verifique que la aplicación que solicita un token de acceso es la misma que inició la autenticación.
   • Allow Resource Owner Password Credentials Flow. Permite a los usuarios autenticarse usando su nombre de usuario y contraseña. Esto implica que la aplicación tenga acceso a la contraseña del usuario y requiere un alto nivel de confianza entre el usuario y la aplicación.
   • Seleccione Allow issuing refresh tokens to refresh access tokens. Esta opción permite emitir tokens de actualización para obtener tokens de acceso renovados. La aplicación puede solicitar nuevos tokens de acceso utilizando los tokens de actualización sin interactuar con el usuario. Las aplicaciones deben almacenar los tokens de actualización de forma segura porque permiten que el usuario permanezca autenticado.
5. Allow client credentials flow. Permite que las aplicaciones se autoricen utilizando el flujo OAuth 2.0 Client Credentials, otorgándoles acceso a Vantage API. Los roles asignados a las aplicaciones se determinan mediante la configuración Manage Roles situada debajo de Allow client credentials flow. Con los roles especificados, la aplicación iniciará sesión en Vantage.
6. Configure los Token Lifetime Settings:
   • Access Token. Define el período de tiempo durante el cual el token de acceso emitido permite el acceso del usuario a Vantage. El tiempo de vida predeterminado de un token de acceso es de 24 horas.
   • Refresh Token. Define el período de tiempo absoluto a partir de la emisión del primer token de acceso durante el cual el token de actualización emitido puede utilizarse para renovar el token de acceso. El tiempo de vida predeterminado de un token de actualización es de 30 días.