Use la interfaz de usuario de Vantage para crear, configurar y eliminar clientes de API pública que usan las aplicaciones integradas para autenticarse en la Vantage API. Como alternativa programática, consulte Creación de un cliente mediante la Vantage API.Documentation Index
Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt
Use this file to discover all available pages before exploring further.
Solo un Administrador del tenant puede crear o administrar clientes de API pública.
Creación de un cliente de API pública
Iniciar la creación del cliente
En el cuadro de diálogo Tenant Administration, haga una de las siguientes acciones:
- Primer cliente de este tenant: haga clic en Create API Client.
- Cualquier cliente posterior: haga clic en cliente de API pública y, en la página cliente de API pública, abra la lista desplegable New Client y haga clic en Add Client.
Copiar el Client ID y el Client Secret
En el cuadro de diálogo Client Created, copie cada valor haciendo clic en su icono de copy. Como alternativa, haga clic en Save to File para descargar un archivo TXT con ambos valores.
Configurar un cliente de API pública
Asigne un nombre al cliente
En el campo Client Name, introduzca un nombre que identifique a este cliente.
Administre secretos
Haga clic en Add Secret para crear un nuevo secreto de cliente. De forma predeterminada, el nuevo secreto vence en 6 meses; puede establecer un vencimiento de entre 1 día y 36 meses.
Agregue direcciones URL de redirección
Haga clic en Add Redirect URL e introduzca cada URL a la que quiera permitir redirecciones de autorización.
Configure los flujos de OAuth 2.0
En la sección OAuth 2.0 Flows Settings, seleccione uno o varios flujos que el cliente pueda usar:
- Allow Authorization Code Flow — un esquema de autenticación seguro en el que la aplicación envía la solicitud de autenticación directamente al servidor de autorización de Vantage. El servidor verifica las credenciales y devuelve un código de autorización. Este flujo está habilitado para todos los clientes de la Vantage API.
- Require PKCE for Authorization Code Flow — refuerza la seguridad de los clientes públicos al permitir que Vantage verifique que la aplicación que solicita el token de acceso es la misma que inició la autenticación.
- Allow Resource Owner Password Credentials Flow — permite a los usuarios autenticarse con su nombre de usuario y contraseña. La aplicación tiene acceso directo a la contraseña del usuario, así que úselo solo con aplicaciones en las que el usuario confíe plenamente.
- Allow issuing refresh tokens to refresh access tokens — permite que el cliente emita tokens de actualización para renovar tokens de acceso sin volver a solicitar la autenticación del usuario. Las aplicaciones deben almacenar los tokens de actualización de forma segura.
- Allow client credentials flow — concede a las aplicaciones acceso a la Vantage API mediante el flujo OAuth 2.0 Client Credentials. Los roles se determinan mediante la configuración Manage Roles situada debajo de esta opción.
El flujo Resource Owner Password Credentials no funciona cuando hay un proveedor de identidades externo configurado. Consulte Authentication.
Establezca la duración de los tokens
En la sección Token Lifetime Settings, configure lo siguiente:
- Access Token — el período durante el cual un token de acceso emitido concede acceso a Vantage. Predeterminado: 24 horas.
- Refresh Token — el período absoluto, a partir de la emisión del primer token de acceso, durante el cual el token de actualización puede renovar el token de acceso. Predeterminado: 30 días.
Eliminación de un cliente de API pública
Administración de clientes de Vantage API
Información general sobre la administración de clientes de la API en su tenant
Crear un cliente con Vantage API
Alternativa programática: cree clientes mediante la API de administración
Autenticación
Flujos de inicio de sesión y opciones de OAuth 2.0 / SAML 2.0