Premiers pas avec les API externes

Cette page vous explique comment passer votre premier appel d’API authentifié vers UiPath. Il utilise le flux d’informations d’identification du client avec une application externe confidentielle, le point de départ recommandé pour les scripts de production, l’automatisation administrative et le travail d’intégration.

Remarque :

Choisir le bon outil

La documentation UiPath Swagger vous permet d'explorer les points de terminaison d'API disponibles et de comprendre les formats de demande et de réponse de manière interactive dans un navigateur. Utilisez Swagger pour la découverte et les tests manuels uniquement. Pour l'automatisation de la production, les scripts et l'intégration, utilisez Postman, cURL ou votre code d'application - ils prennent en charge le flux de jetons de porteur OAuth 2.0 complet requis pour autoriser les demandes faites aux API UiPath.

Prérequis

• Un administrateur d’organisation UiPath a enregistré une application externe confidentielle avec le type d’octroi Informations d’identification du client et lui a attribué les étendues requises.
• Vous disposez de l’ ID et de la clé secrète de l’application pour l’application enregistrée.

Pour plus d’informations sur l’enregistrement d’applications externes et le choix du type d’octroi approprié, consultez la section Applications externes.

Étape 1: obtenir un jeton de porteur

Envoyez une requête POST au point de terminaison du jeton Identity Server pour recevoir un jeton du porteur.

curl -X POST "https://cloud.uipath.com/{organizationName}/identity_/connect/token" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials&client_id={app_id}&client_secret={app_secret}&scope={scopes}"

Remplacez les espaces réservés suivants:

Espace réservé	Valeur (Value)
{organizationName}	Le nom de votre organisation, tel qu'il apparaît dans l'URL d'Automation Cloud
{app_id}	L’ID de votre enregistrement d’application externe
{app_secret}	La clé secrète de l’application de l’enregistrement de votre application externe
{scopes}	Liste des étendues séparées par des espaces accordées à l'application, par exemple: OR.Users.View PM.Users

La réponse renvoie un jeton de porteur:

{
    "access_token": "{access_token}",
    "expires_in": 3600,
    "token_type": "Bearer",
    "scope": "{scopes}"
}

Copiez la valeur access_token . Le jeton est valide pendant une heure.

Remarque :

Si vous utilisez Postman ou un outil similaire, définissez le type de contenu de la requête sur application/x-www-form-urlencoded.

Étape 2: Appeler un point de terminaison de l'API

Incluez le jeton du porteur dans l'en-tête Authorization de votre requête d'API.

L'exemple suivant récupère une liste de machines d'Orchestrator:

curl -X GET "https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/Machines" \
  -H "Authorization: Bearer {access_token}" \
  -H "accept: application/json"

Remplacez {tenantName} par le nom de votre locataire Orchestrator et {access_token} par le jeton de l'étape 1.

Résultat

Une requête réussie renvoie HTTP 200 avec les données demandées au format JSON.

Si la demande échoue, vérifiez les éléments suivants:

• Le jeton n’a pas expiré. Les jetons expirent après une heure — répétez l'étape 1 pour demander un nouveau jeton.
• La valeur d'en-tête Authorization est formatée exactement en tant que Bearer {access_token}.
• Les étendues accordées à votre application externe couvrent le point de terminaison demandé. Pour trouver les valeurs d'étendue d'un point de terminaison spécifique, consultez la page de documentation de ce point de terminaison dans ce guide, spécifiquement sous le chapitre API de gestion de plate-forme .

Prochaines étapes

• Pour tous les types d’accords et flux OAuth, y compris le code d’autorisation et PKCE pour l’accès délégué par l’utilisateur, consultez la section Applications externes.
• Pour tous les points de terminaison Identity Server utilisés dans l'authentification, consultez Points de terminaison UiPath Identity Server.
• Pour comprendre comment structurer les URL des points de terminaison de l'API, consultez Structure des URL des points de terminaison de l'API.