Utilisation de l'API de cloud

Vue d'ensemble (Overview)

UiPath Automation Cloud pour le secteur public dispose de deux mécanismes pour utiliser les API :

• obtention des informations d'accès à l'API à partir d'Automation Cloud pour le secteur public (décrit sur cette page) ;
• enregistrement d'une application externe pour utiliser le flux OAuth (informations et instructions).

Quel mécanisme utiliser ? Vous pouvez utiliser le mécanisme de votre choix, mais si votre organisation Automation Cloud pour le secteur public utilise le modèle Azure Active Directory, vous devez enregistrer les applications externes dans Automation Cloud pour le secteur public et utiliser le flux OAuth.

Remarque :

Tous les clients qui se connectaient à Orchestrator CE via l'API, ou utilisaient PowerShell et d'autres outils de script, doivent être mis à jour pour se connecter à UiPath Automation Cloud pour le secteur public.

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.

Obtention des informations d'accès à l'API à partir de l'interface utilisateur d'Automation Cloud pour le secteur public

La page Services dans votre compte Automation Cloud pour le secteur public vous permet d'accéder à des informations spécifiques à l'API pour chacun de vos services existants, ce qui vous permet de trouver facilement les informations requises pour vous authentifier auprès de vos services Orchestrator basés sur le cloud via des appels API.

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. Connectez-vous à votre compte Automation Cloud pour le secteur public.
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://govcloud.uipath.us 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.

Authentification auprès de votre locataire Orchestrator basé sur Automation Cloud pour le secteur public

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://govcloud.uipath.us/{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://govcloud.uipath.us/{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://govcloud.uipath.us/{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 :

Notez que pour les services Automation Cloud pour le secteur public Orchestrator, les résultats affichés par les requêtes API sont limités à 1 000 entrées par 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://govcloud.uipath.us/{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.