Utilisation de l'API de cloud

Vue d'ensemble (Overview)

UiPath Automation Cloud^TM has two mechanisms for consuming APIs:

• getting the API access information from Automation Cloud^TM (described on this page)
• registering an external application to use the OAuth flow ( information and instructions ).

Which mechanism to use? You can use whichever mechanism you want, but if your Automation Cloud^TM organization uses the Azure Active Directory model , you must register external applications in Automation Cloud^TM and use the OAuth flow.

Remarque :

All clients that used to connect to Orchestrator CE via API, or using PowerShell and other scripting tools, need to be updated in order to connect to the UiPath Automation Cloud^TM.

Le système On-Premises Orchestrator ou Orchestrator installé sur votre cloud privé n'a pas été modifié. Vous pouvez continuer à utiliser vos intégrations d'API, PowerShell ou d'autres outils de script comme auparavant lors de la connexion à ces instances Orchestrator.

Getting the API Access Information From the Automation Cloud^TM UI

The Services page within your Automation Cloud^TM account enables you to access API specific information for each of your existing services, allowing you to easily find the information required for authenticating to your cloud-based Orchestrator services via API calls.

Remarque :

Les utilisateurs locaux, quel que soit leur rôle au niveau de l'organisation, peuvent afficher les informations d'accès à l'API pour les services Orchestrator.

Les utilisateurs de l'annuaire ne peuvent pas afficher les informations d'accès à l'API pour un service Orchestrator, comme décrit ci-dessous. À la place, ils doivent enregistrer une application externe et utiliser le flux OAuth.

1. Log in to your Automation Cloud^TM account.
2. Accédez à Admin > Locataires (Tenants). La page Locataires (Tenants) s'ouvre, répertoriant tous les locataires existants.
3. Cliquez sur la flèche à gauche du locataire souhaité pour afficher ses services disponibles.
4. Cliquez sur Accès à l'API (API Access) pour le service Orchestrator. La fenêtre Accès à l'API (API Access) s'ouvre et inclut les informations spécifiques au service suivantes :

• Clé utilisateur (User Key) - vous permet de générer des clés de connexion uniques à utiliser avec des API ou des applications tierces afin de vous connecter et d'effectuer des actions en votre nom. Il était auparavant connu sous le nom de jeton d'actualisation.
• ID de l'organisation (Organization ID) : le nom de votre organisation. Il s'agit du nom suivant l'URL de base.
• Nom du locataire (Tenant Name) : le nom complet du locataire.

• ID 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 locataires sur https://cloud.uipath.com ont la même valeur d'ID client.

  
  

  

  
  

Ne fermez pas cette fenêtre. Vous avez besoin de ces informations pour passer l’appel d'authentification. Copiez les valeurs en cliquant sur le bouton de copie à côté de chaque champ.

Authenticating to Your Automation Cloud^TM Based Orchestrator Tenant

L'opération d'authentification envoie une requête POST à https://account.uipath.com/oauth/token. La requête et la réponse doivent ressembler à l'exemple suivant :

Publier

https://account.uipath.com/oauth/token

En-têtes de requête

Clé (Key)	Valeur (Value)
Autorisation	Porteur

Corps de la requête

{
    "grant_type": "refresh_token",
    "client_id": "{client_ID}",
    "refresh_token": "{user_key}"
}

Codes de réponse

200 OK

Corps de la réponse

{
  "access_token": "{access_token}",
  "id_token": "{id_token}",
  "scope": "openid profile email offline_access",
  "expires_in": 86400,
  "token_type": "Bearer"
}

Remarque : vous obtenez les valeurs {tenant_name}, {client_ID} et {user_key} à partir de la page Accès à l'API (API Access), comme décrit dans la section précédente.

Copiez l'{access_token} pour une utilisation ultérieure.

Important : l'{access_token} requis pour passer des appels d'API Orchestrator est valide pendant 24 heures. Vous devez régénérer l'{access_token} à l'aide de votre {refresh_token} ; sinon, vous recevez un code de statut 401.

Passer des appels d'API Orchestrator

1. Exécuter une requête GET pour https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/Settings/UiPath.Server.Configuration.OData.GetLicense
2. Remplacez {organization_name} et {tenant_name} par les valeurs de la page Accès à l'API (API Access).
3. Définissez l'en-tête d'autorisation (Authorization) sur Bearer {access_token} et collez la valeur {access_token} reçue lors de la procédure ci-dessus.

Après avoir envoyé la demande, vous devriez obtenir une réponse d'Orchestrator avec les informations de licence pour ce service.

La requête et la réponse doivent ressembler à l'exemple suivant :

Obtenir

https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/Settings/UiPath.Server.Configuration.OData.GetLicense

En-têtes de requête

Clé (Key)	Valeur (Value)
Autorisation	Porteur

Codes de réponse

200 OK

Corps de la réponse

{
    "@odata.context": "https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#UiPath.Application.Dto.License.LicenseDto",
    "HostLicenseId": null,
    "Id": 0,
    "ExpireDate": 1622678399,
    "GracePeriodEndDate": 1622678399,
    "GracePeriod": null,
    "AttendedConcurrent": false,
    "DevelopmentConcurrent": false,
    "StudioXConcurrent": false,
    "LicensedFeatures": [],
    "IsRegistered": true,
    "IsExpired": false,
    "CreationTime": "2019-11-28T06:16:21.373Z",
    "Code": "d1c8-4785-55ace9a0c233",
    "Allowed": {
        "Unattended": 1,
        "Attended": 1,
        "NonProduction": 0,
        "Development": 1,
        "StudioX": 0
    },
    "Used": {
        "Unattended": 0,
        "Attended": 0,
        "NonProduction": 0,
        "Development": 1,
        "StudioX": 0
    }
}

Important :

Tous les appels d'API Orchestrator postérieurs à l'autorisation initiale doivent être redirigés vers l'URL Orchestrator.

Ils doivent contenir les en-têtes suivants :

• Authorization: Bearer {access_token}

Pour accéder aux ressources d'un dossier, n'oubliez pas d'ajouter FolderId ou FolderPath dans un en-tête HTTP, comme expliqué sur la page Création des requêtes API (Building API Requests). Par exemple :

• X-UIPATH-OrganizationUnitId: {FolderId}

Important :

Note that, for Automation Cloud^TM Orchestrator services, the results displayed by the API requests are limited to 1,000 entries for each page.

Vous pouvez utiliser les paramètres $top et $skip dans vos requêtes pour récupérer les pages suivantes. Par exemple, utilisez la requête GET https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/RobotLogs?$top=1000&$skip=2000 pour récupérer les entrées de journal du Robot comprises entre 2 001 et 3 000.