| Parameter | Descripción |
|---|---|
| client_id | Identificador de la aplicación. Para saber cómo crear un Vantage API Client (client_id y client_secret), consulte el artículo Managing Tenant Vantage API Clients. |
| redirect_uri | La URL de su aplicación o sitio web a la que se redirigirá el navegador una vez otorgados los permisos de acceso. |
| response_type=code | Especifica que se utiliza el tipo de respuesta de código de autorización. |
| scope=openid permissions global.wildcard | Especifica el ámbito de permisos. |
| state | Un valor de cadena arbitrario que contendrá el resultado de la autorización en la respuesta. |
| code_challenge | Valor firmado digitalmente del code_verifier (usando code_challenge_method). |
| code_challenge_method | El método de firma digital para code_verifier (S256). |
| productId=a8548c9b-cb90-4c66-8567-d7372bb9b963 | Identificador de Vantage. |
Los valores de response_type, scope y productId deben ser exactamente los indicados arriba. Estas claves, excepto response_type, pueden cambiar. Considere mantenerlas en la configuración.Solicitud de ejemplo Un parámetro llamado redirect_uri que contiene el identificador de su recurso se utiliza en OAuth 2.0 para permitir que Vantage envíe el código de autorización a su recurso y luego intercambie ese código por el token de acceso, necesario para la autenticación en todas las llamadas posteriores a la API. El uso de este método de autenticación requiere proporcionar el valor del parámetro redirect_uri al soporte técnico de ABBYY para que los administradores lo incluyan en la lista de permitidos. Una vez verificado que se han concedido los permisos de acceso solicitados mediante el parámetro scope, el navegador se redirige a una página web específica configurada por el servidor de Vantage. Esta página web contiene un cuadro de diálogo que se utiliza para completar la autorización con su cuenta. Esta página debe abrirse en un navegador que tenga visible la barra de direcciones, lo que le permitirá verificar la URL de la página y el estado del certificado SSL de la conexión. Si su dirección de correo electrónico está vinculada a varias cuentas en distintos tenants, se le pedirá que seleccione un tenant e introduzca su contraseña después de especificar su dirección de correo electrónico. También puede pasar su identificador de tenant (el parámetro tokenId) directamente mediante uno de los siguientes recursos: o Se te pedirá que introduzcas la contraseña de tu cuenta de inquilino. Una vez que hayas introducido tus credenciales, la autorización se completa del lado del servidor, la aplicación obtiene acceso a la Vantage API y recibes el código de autorización en la respuesta a tu solicitud. Tenga en cuenta que, si un sitio o aplicación utiliza este tipo de autenticación, los usuarios de Vantage concederán acceso a la Vantage API en su nombre al sitio o aplicación que está añadiendo a la lista de URL de redirección permitidas. Para proporcionar acceso al sitio o a la aplicación, se pedirá a los usuarios que se autentiquen en Vantage con su nombre de usuario y contraseña. Una vez que el usuario se haya autenticado, al sitio o a la aplicación se le otorgarán los siguientes permisos:
- Administrar catálogos de datos en el tenant de Vantage en nombre del usuario.
- Acceder a skills en el tenant de Vantage en nombre del usuario.
- Crear y acceder a transacciones de Vantage en nombre del usuario.
application/x-www-form-urlencoded.
Parámetros del cuerpo de la solicitud:
| Parameter | Descripción |
|---|---|
| code_verifier | El código que generó. Necesario para confirmar el inicio de la solicitud de autorización. |
| client_id | El identificador de la aplicación. |
| client_secret | Clave segura de la aplicación. |
| code | Su código de autorización obtenido del servidor. |
| redirect_uri | La URL de redirección utilizada en el paso de autorización. |
| grant_type=authorization_code | Especifica que se utiliza el tipo de concesión “authorization code”. |
| scope=openid permissions global.wildcard offline_access | Especifica el ámbito de permisos. Para obtener un token de actualización, agregue offline_access al ámbito. |
token por el valor que recibió:
Obtención del token de actualización
Allow issuing refresh tokens to refresh access tokens estaba habilitada al configurar el cliente de Vantage API y la solicitud para obtener el token de acceso contenía el parámetro scope=openid permissions global.wildcard offline_access, también recibirá un token de actualización adicional en la respuesta. Una vez que tenga un token de actualización, puede renovar el token de acceso mediante una solicitud POST al endpoint de token con los siguientes parámetros:
| Parámetro | Descripción |
|---|---|
| client_id | El identificador de la aplicación. |
| client_secret | Una clave segura de la aplicación. |
| refresh_token | Su token de actualización obtenido del servidor. |
| grant_type=refresh_token | Especifica que se usa el tipo de concesión de token de actualización. |
Vigencia de los tokens
- Vigencia del token de acceso: Define el periodo durante el cual el token de acceso emitido permite el acceso del usuario a Vantage. La vigencia predeterminada de un token de acceso es de 24 horas.
- Vigencia del token de actualización: Define el periodo absoluto que comienza con 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. La vigencia predeterminada de un token de actualización es de 30 días.