Saltar al contenido principal
Puede crear y configurar clientes de la Vantage API en la pestaña Configuration del panel izquierdo. Para crear un cliente de API, siga estos pasos:
  1. Haga clic en Create API Client.
Create API Client
  1. En el cuadro de diálogo que se abrirá, se mostrarán el Client ID y el Client Secret del cliente creado. Puede guardar sus valores haciendo clic en el icono junto a cada uno. Alternativamente, puede hacer clic en el botón Save to File y especificar una ubicación donde se guardará un archivo TXT que contiene los valores de Client ID y Client Secret.
Importante: El valor del secreto se muestra solo una vez durante la creación del cliente, por lo que debe guardarse de inmediato. Client ID and Secret Dialog
  1. Haga clic en Close.
Después de los pasos anteriores, se le dirigirá automáticamente a la página de edición del cliente creado. Allí podrá realizar lo siguiente:
  • Cambiar el nombre del cliente indicado en el campo Client Name.
  • Crear un nuevo secreto haciendo clic en Add Secret. De forma predeterminada, un secreto se crea por un período de 6 meses.
  • Agregar una nueva url de redirección haciendo clic en Add Redirect URL.
  • Configurar los flujos de autenticación permitidos en la sección OAuth 2.0 Flows Settings. Tenga en cuenta que puede seleccionar más de un flujo:
    • Allow Authorization Code Flow. Permite la autenticación usando este esquema seguro, en el que, en lugar de dirigir la solicitud de autenticación al usuario, la aplicación la envía directamente al servidor de autorización de Vantage. Luego, el servidor de autorización verifica las credenciales del usuario y proporciona al cliente un código de autorización. Authorization Code Flow está habilitado para todos los clientes de la 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 a Vantage verificar que la aplicación que solicita un token de acceso sea la misma que inició la autenticació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 con 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.
    • Allow Resource Owner Password Credentials Flow. Permite a los usuarios autenticarse con 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.
Nota: Este flujo no funciona cuando se configura un proveedor de identidad externo.
  • Allow client credentials flow. Permite que las aplicaciones se autoricen mediante el flujo OAuth 2.0 Client Credentials, otorgándoles acceso a la Vantage API. Los roles asignados a las aplicaciones se determinan mediante la configuración Manage Roles debajo de Allow client credentials flow. Con los roles especificados, la aplicación iniciará sesión en Vantage.
Para obtener más información sobre los flujos de autenticación, consulte Authentication. OAuth 2.0 Configuration Si desea crear un nuevo cliente, seleccione Add Client en la lista desplegable New Client. Esta lista también mostrará todos los clientes existentes; al hacer clic en cualquiera de ellos, se abrirá la página de edición del cliente seleccionado. Además, si es necesario, puede buscar por nombre de cliente y roles. New Client Dropdown Para eliminar un cliente, haga clic en el icono y luego en Delete Client. Delete Client