Accès à l’API

Appelez l’API Integration Service à partir d’une application externe, à l’aide de l’autorisation OAuth 2.0 et des étendues Integration Service.

Vue d'ensemble (Overview)

L’API Integration Service vous permet de travailler avec les ressources Integration Service à partir de l’application externe de votre choix. Vous autorisez l'application via l'infrastructure OAuth 2.0, afin qu'un service ou un script puisse s'authentifier de manière autonome au lieu de s'appuyer sur une session utilisateur connectée, et sans partager d'informations d'identification.

Utilisez-le pour appeler Integration Service à partir d'un pipeline CI/CD qui publie ou déploie une solution référençant un connecteur personnalisé, ou à partir d'une application ou d'un agent codé qui doit créer ou gérer ses propres connexions Integration Service sans utilisateur connecté.

L’accès est limité aux étendues que vous accordez. Une application externe, ou un utilisateur agissant via une application, ne peut pas dépasser ces autorisations. L’accès existant à l’API utilisant des jetons utilisateur est inchangé.

Découvrez comment enregistrer une application externe.

Autorisations d'API

Pour appeler l’API Integration Service, vous devez accorder des autorisations d’API à l’application externe. Ces autorisations sont appelées étendues. Ajoutez-les dans Automation Cloud sous Admin > Applications externes en ajoutant Integration Service en tant que ressource.

Portée	Accorder	Disponible en tant que
IS.Connections.Lire	Accès en lecture aux connexions.	Étendue de l'utilisateur
IS.Connectors.Read	Accès en lecture aux connecteurs, y compris le téléchargement d'un connecteur personnalisé.	Étendue de l'utilisateur, étendue de l'application
IS.Connector.Export	Non utilisé. Aucun point de terminaison ne nécessite cette étendue.	S/O

Important :

IS.Connections.Read est une étendue d’utilisateur uniquement. Une application externe qui s’authentifie par elle-même, sans utilisateur connecté, ne peut pas être accordée.

Les applications non confidentielles peuvent uniquement se voir accorder des étendues d’utilisateur. Pour connaître la différence entre les types d'applications et entre les étendues des utilisateurs et des applications, consultez Autoriser les applications externes.

Autoriser les appels d'API

Autorisez votre application externe en créant un jeton d’accès pour elle. Utilisez l’ ID d’application et le secret d’application générés lors de l’enregistrement de l’application. La méthode d'autorisation dépend du type de demande, confidentiel ou non confidentiel.

En savoir plus sur les méthodes d'autorisation pour les applications externes.

Envoyez le jeton en tant que jeton de porteur sur vos requêtes. Un jeton est valide pendant une heure. Pour continuer à appeler l’API après cela, générez un nouveau jeton d’accès ou demandez un jeton d’actualisation.

Étendue du dossier

Une application externe doit cibler un seul dossier pour chaque requête, en utilisant l’en-tête X-UIPATH-FolderKey , et elle a besoin de l’autorisation Connections.View dans ce dossier. Les demandes qui omettent l'en-tête et les demandes qui demandent tous les dossiers sont rejetées.

Une connexion qui existe dans un dossier différent de celui que vous avez ciblé est signalée comme introuvable, plutôt qu’interdite.

Points de terminaison disponibles

Le guide de l'API documente actuellement ces points de terminaison:

• Obtenir des connexions
• Obtenir la connexion par ID
• Télécharger le connecteur personnalisé

Les réponses à une application externe omettent le propriétaire de la connexion, l'ID d'instance de l'élément, l'intervalle d'interrogation et l'indicateur « Apportez-votre-propre-application ». La configuration d'une connexion est renvoyée uniquement aux appelants qui détiennent l'étendue de lecture de la configuration, et les valeurs secrètes telles que les clés API et les jetons OAuth ne sont jamais renvoyées.

Pour plus de détails sur chaque point de terminaison, consultez le guide de l’API Integration Service.