Clés API

Les clés API sont utilisées afin d’établir une connexion entre la UiPath® Platform et d’autres applications externes à celle-ci. Les applications externes peuvent être des applications de bureau UiPath ou des applications tierces.

Les clés API sont disponibles pour plusieurs services UiPath (produits).

Important : la prise en charge de l'authentification par clé API prendra fin en mars 2025. Nous vous recommandons d’utiliser les applications externes ou les jetons d’accès personnels (PAT) comme principale méthode d’authentification.

En savoir plus sur les obsolescences à venir.

Orchestrator

À propos de l'accès aux API

Vous pouvez afficher les informations d'accès à l'API pour chacun de vos services Orchestrator existants sur la page Admin > Locataire > Services (Admin > Tenant > Services).

Ces informations sont requises pour vous authentifier auprès de votre service Orchestrator dans Automation Cloud via Appels d’API.

Remarque : si vous n’avez pas accès à la page Admin, qui n’est disponible que pour les utilisateurs qui disposent du rôle d’administrateur de l’organisation, vous pouvez obtenir des informations d’accès à l’API à partir de la page Préférences de votre compte.

Important :

Non applicable pour Azure AD

Si les paramètres d’authentification de votre organisation sont définis pour utiliser Azure Active Directory (Azure AD), le bouton Accès à l’API n’est pas disponible et les instructions de cette page ne s’appliquent pas pour vous.

Dans ce cas, vous devez effectuer l'une des opérations suivantes :

• déconnectez-vous d’Automation Cloud, puis connectez-vous avec un compte UiPath® au lieu d’un compte Azure AD, ou bien
• (recommandé) utilisez plutôt le flux OAuth (OAuth flow).

Affichage des informations d'accès à l'API

Vous pouvez afficher les informations d'accès à l'API pour un service si vous avez le rôle Administrateur de l'organisation (Organization Administrator), ou si vous êtes affecté à ce service.

1. Accédez à Admin et sélectionnez le locataire dans le panneau de gauche.
2. Cliquez sur Services.

   La page Services s'affiche, et répertorie tous les services existants pour le locataire sélectionné.

3. Cliquez sur sur la carte Orchestrator et sélectionnez Accès à l'API (API Access).
   
   

   

   
   

   La fenêtre Accès à l'API (API Access) s'affiche avec les informations spécifiques au service suivantes :

   • Clé utilisateur (User Key) : vous permet de générer des clés de connexion uniques à utiliser via des API ou des applications externes afin de vous connecter et d'effectuer des actions en votre nom. Cette option s'appelait auparavant jeton d'actualisation.
   • Nom logique du compte (Account Logical Name) : est le nom de votre organisation (par exemple myNewOrg).
   • Nom du locataire (Tenant Name) - le nom d'affichage du locataire.
   • Id du client (Client Id) - spécifique à l'application Orchestrator elle-même, il est le même pour tous les utilisateurs et services Orchestrator sur une plate-forme spécifique. Par exemple, tous les services Orchestrator sur cloud.uipath.com ont la même valeur d'ID client.
4. Cliquez sur l'icône à côté de n'importe quel champ pour copier sa valeur.
   
   

   

   
   

Vous pouvez utiliser les informations copiées pour utiliser des API cloud .

Révoquer l'accès à l'API

La révocation de l'accès annule toutes les clés d'utilisateur précédemment attribuées, cassant ainsi toutes les applications qui reposent sur des clés d'utilisateur précédemment attribuées. Une nouvelle clé utilisateur est automatiquement générée pour le service Orchestrator sélectionné.

Vous devez partager la nouvelle clé utilisateur avec toutes les applications concernées.

1. Accédez à Admin et sélectionnez le locataire dans le panneau de gauche.
2. Cliquez sur Services.

   La page Services s'affiche, et répertorie tous les services existants pour le locataire sélectionné.

3. Cliquez sur sur la carte Orchestrator et sélectionnez Accès à l'API (API Access).

   La fenêtre Accès à l'API (API access) s'ouvre.

4. Cliquez sur Révoquer l'accès (Revoke Access).

   Une fenêtre de confirmation s'ouvre.

5. Cliquez sur Révoquer (Revoke) pour confirmer votre action.

   La valeur de la Clé utilisateur (User Key) du service est révoquée et la fenêtre Jetons d'actualisation révoqués (Refresh Tokens Revoked) s'affiche.

6. Fermez la fenêtre Jetons d'actualisation révoqués.
7. Copiez et partagez la nouvelle clé avec les utilisateurs qui en ont besoin.

Document Understanding

La clé API pour Document Understanding est disponible sur la page Administrateur > Licences > Consommables > AI Units :

À partir de là, vous pouvez :

• Copier la clé pour l'utiliser dans des applications externes.
• Cliquer sur l'icône Actualiser (Refresh) pour générer une nouvelle clé.
  Attention : La génération d'une nouvelle clé rend l'ancienne clé non valide. Toutes les applications externes qui utilisaient l'ancienne clé ne pourront plus se connecter à Automation Cloud.

Pour plus d'informations, consultez Clé API (API Key) dans la documentation Document Understanding.

Computer Vision

La clé API pour Computer Vision est disponible sur la page Admin > Organisation > Licences > Robots et services (Admin > Organization > Licenses > Robots & Services).

À partir de là, vous pouvez :

• Copier la clé pour l'utiliser dans des applications externes.

• Cliquer sur l'icône Actualiser (Refresh) pour générer une nouvelle clé.

  Attention : La génération d'une nouvelle clé rend l'ancienne clé non valide. Toutes les applications externes qui utilisaient l'ancienne clé ne pourront plus se connecter à Automation Cloud.

Pour plus d'informations, consultez la rubrique Computer Vision .