Passer au contenu principal

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.

Utilisez l’interface Vantage pour créer, configurer et supprimer des clients d’API publics utilisés par les applications d’intégration pour s’authentifier auprès de l’API Vantage. Pour l’alternative programmatique, consultez Création d’un client à l’aide de l’API Vantage.
Seul un administrateur de tenant peut créer ou gérer des clients d’API publics.

​
Création d’un client d’API publique

1

Ouvrir la configuration

Dans Vantage, cliquez sur Configuration dans le volet gauche.
2

Commencer à créer le client

Dans la boîte de dialogue Tenant Administration, effectuez l’une des actions suivantes :
  • Premier client dans ce tenant : cliquez sur Create API Client.
  • Tout client supplémentaire : cliquez sur client d’API public, puis, sur la page client d’API public, ouvrez la liste déroulante New Client et cliquez sur Add Client.
Liste déroulante New Client avec l’option Add Client
3

Copier le Client ID et le Client Secret

Dans la boîte de dialogue Client Created, copiez chaque valeur en cliquant sur son icône copy. Vous pouvez aussi cliquer sur Save to File pour télécharger un fichier TXT contenant les deux valeurs.
Boîte de dialogue Client Created avec Client ID et Client Secret
Le secret client n’est affiché qu’une seule fois, lors de sa création. Enregistrez-le immédiatement — vous ne pourrez plus consulter sa valeur complète par la suite.
4

Fermer la boîte de dialogue

Cliquez sur Close. La page client d’API public s’ouvre, où vous pouvez configurer le nouveau client.

​
Configuration d’un client d’API publique

Après avoir créé un client d’API publique, configurez ses paramètres. Pour ouvrir les paramètres d’un client, cliquez sur son nom dans la page client d’API public ou recherchez-le par nom de client ou par rôles du principal d’application.
Page de configuration OAuth 2.0 de client d’API public
1

Nommer le client

Dans le champ Client Name, saisissez un nom permettant d’identifier ce client.
2

Gérer les secrets

Cliquez sur Add Secret pour créer un nouveau secret client. Par défaut, le nouveau secret expire au bout de 6 mois — vous pouvez définir une durée d’expiration comprise entre 1 jour et 36 mois.
3

Ajouter des URL de redirection

Cliquez sur Add Redirect URL et saisissez chaque URL vers laquelle vous souhaitez autoriser les redirections d’autorisation.
4

Configurer les flux OAuth 2.0

Dans la section OAuth 2.0 Flows Settings, sélectionnez un ou plusieurs flux que le client peut utiliser :
  • Allow Authorization Code Flow — un mécanisme d’authentification sécurisé dans lequel l’application envoie la requête d’authentification directement au serveur d’autorisation Vantage. Le serveur vérifie les informations d’identification et renvoie un code d’autorisation. Ce flux est activé pour tous les clients de l’API Vantage.
    • Require PKCE for Authorization Code Flow — renforce la sécurité des clients publics en permettant à Vantage de vérifier que l’application qui demande le jeton d’accès est bien celle qui a initié l’authentification.
  • Allow Resource Owner Password Credentials Flow — permet aux utilisateurs de s’authentifier avec leur nom d’utilisateur et leur mot de passe. L’application ayant un accès direct au mot de passe de l’utilisateur, utilisez cette option uniquement avec des applications auxquelles l’utilisateur fait entièrement confiance.
  • Allow issuing refresh tokens to refresh access tokens — permet au client d’émettre des jetons d’actualisation pour renouveler les jetons d’accès sans demander à nouveau l’intervention de l’utilisateur. Les applications doivent stocker les jetons d’actualisation de manière sécurisée.
  • Allow client credentials flow — accorde aux applications l’accès à l’API Vantage via le flux OAuth 2.0 Client Credentials. Les rôles sont déterminés par le paramètre Manage Roles situé sous cette option.
Le flux Resource Owner Password Credentials ne fonctionne pas lorsqu’un fournisseur d’identité externe est configuré. Voir Authentication.
5

Définir la durée de vie des jetons

Dans la section Token Lifetime Settings, configurez :
  • Access Token — la durée pendant laquelle un jeton d’accès émis donne accès à Vantage. Par défaut : 24 heures.
  • Refresh Token — la durée absolue, à compter de l’émission du premier jeton d’accès, pendant laquelle le jeton d’actualisation peut renouveler le jeton d’accès. Par défaut : 30 jours.
Pour plus d’informations sur les flux d’authentification, voir Authentication.

​
Suppression d’un client d’API publique

Pour supprimer un client, cliquez sur son icône sur la page client d’API public, puis cliquez sur Delete Client.
Page client d’API public avec le bouton Delete Client mis en évidence dans la barre d’outils du client

Gérer les clients de l’API Vantage

Vue d’ensemble de la gestion des clients de l’API dans votre tenant

Créer un client à l’aide de l’API Vantage

Alternative par programmation — créez des clients via l’API d’administration

Authentification

Flux de connexion et options OAuth 2.0 / SAML 2.0