| Parameter | Description |
|---|---|
| client_id | L’identifiant de l’application. Pour savoir comment créer un client de l’API Vantage (client_id et client_secret), consultez l’article Managing Tenant Vantage API Clients. |
| redirect_uri | L’URL de votre application ou de votre site web utilisée pour rediriger le navigateur une fois les autorisations d’accès accordées. |
| response_type=code | Indique que le type de réponse « authorization code » est utilisé. |
| scope=openid permissions global.wildcard | Indique le périmètre d’autorisation. |
| state | Une valeur string arbitraire qui contiendra le résultat de l’autorisation dans la réponse. |
| code_challenge | Valeur signée numériquement du code_verifier (en utilisant la méthode code_challenge_method). |
| code_challenge_method | La méthode de signature numérique pour le code_verifier (S256). |
| productId=a8548c9b-cb90-4c66-8567-d7372bb9b963 | L’identifiant Vantage. |
Les valeurs pour response_type, scope et productId doivent être exactement celles indiquées ci-dessus. Ces clés, à l’exception de response_type, sont susceptibles de changer. Envisagez de les conserver dans une configuration.Sample Request Un paramètre appelé redirect_uri, qui contient l’identifiant de votre ressource, est utilisé dans OAuth 2.0 afin de permettre à Vantage d’envoyer le code d’autorisation à votre ressource, puis d’échanger ce code contre le jeton d’accès, requis pour l’authentification lors de tous les appels API ultérieurs. L’utilisation de cette méthode d’authentification nécessite de fournir la valeur du paramètre redirect_uri à l’assistance technique d’ABBYY afin qu’elle soit ajoutée à la liste d’autorisation par les administrateurs. Une fois que les autorisations d’accès demandées à l’aide du paramètre scope ont été confirmées comme accordées, le navigateur est redirigé vers une page Web spéciale configurée par le serveur Vantage. Cette page comporte une fenêtre de dialogue permettant de procéder à l’autorisation avec votre compte. Cette page doit être ouverte dans un navigateur doté d’une barre d’adresse visible, ce qui vous permettra de vérifier l’URL de la page et l’état du certificat SSL de la connexion. Si votre adresse e-mail est associée à plusieurs comptes dans différents tenants, il vous sera demandé de sélectionner un tenant et de saisir votre mot de passe après avoir indiqué votre adresse e-mail. Vous pouvez également transmettre l’identifiant de votre tenant (le paramètre tokenId) directement en utilisant l’une des ressources suivantes : ou Vous devrez saisir le mot de passe de votre compte client. Une fois vos identifiants saisis, l’autorisation est effectuée côté serveur, l’application se voit accorder l’accès à l’API Vantage et vous recevez le code d’autorisation dans la réponse à votre requête. Veuillez noter que si un site ou une application utilise ce type d’authentification, les utilisateurs de Vantage accorderont, en leur nom, l’accès à l’API Vantage au site ou à l’application que vous ajoutez à la liste des URL de redirection autorisées. Pour accorder l’accès au site ou à l’application, il sera demandé aux utilisateurs de s’authentifier dans Vantage à l’aide de leur identifiant et de leur mot de passe. Une fois l’utilisateur authentifié, le site ou l’application se verra accorder les autorisations suivantes :
- Gérer les catalogues de données dans le locataire Vantage au nom de l’utilisateur,
- Accéder aux compétences dans le locataire Vantage au nom de l’utilisateur,
- Créer et accéder aux transactions Vantage au nom de l’utilisateur.
application/x-www-form-urlencoded.
Paramètres du corps de la requête :
| Parameter | Description |
|---|---|
| code_verifier | Le code que vous avez généré. Nécessaire pour confirmer l’initialisation de la demande d’autorisation. |
| client_id | L’identifiant de l’application. |
| client_secret | La clé sécurisée de l’application. |
| code | Votre code d’autorisation obtenu auprès du serveur. |
| redirect_uri | L’URL de redirection utilisée lors de l’étape d’autorisation. |
| grant_type=authorization_code | Indique que le type d’octroi « authorization code » est utilisé. |
| scope=openid permissions global.wildcard offline_access | Spécifie le périmètre d’autorisation. Pour obtenir un jeton d’actualisation, ajoutez offline_access au périmètre. |
token par la valeur que vous avez reçue :
Obtention du jeton d’actualisation
Allow issuing refresh tokens to refresh access tokens a été activée lors de la configuration du client de l’API Vantage et que la requête pour obtenir le jeton d’accès contenait le paramètre scope=openid permissions global.wildcard offline_access, vous recevrez également un jeton d’actualisation supplémentaire dans la réponse. Une fois que vous disposez d’un jeton d’actualisation, vous pouvez actualiser le jeton d’accès à l’aide d’une requête POST vers le point de terminaison du jeton avec les paramètres suivants :
| Paramètre | Description |
|---|---|
| client_id | L’identifiant de l’application. |
| client_secret | Une clé d’application sécurisée. |
| refresh_token | Votre jeton d’actualisation obtenu auprès du serveur. |
| grant_type=refresh_token | Indique que le type d’octroi basé sur le jeton d’actualisation est utilisé. |
Durée de vie des jetons
- Durée de vie du jeton d’accès : Définit la période pendant laquelle le jeton d’accès émis permet à l’utilisateur d’accéder à Vantage. La durée de vie par défaut d’un jeton d’accès est de 24 heures.
- Durée de vie du jeton d’actualisation : Définit la période maximale, à partir de l’émission du premier jeton d’accès, pendant laquelle le jeton d’actualisation émis peut être utilisé pour renouveler le jeton d’accès. La durée de vie par défaut d’un jeton d’actualisation est de 30 jours.