Nutzung der Cloud-API

Überblick

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.

Hinweis:

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.

Der lokale Orchestrator oder der Orchestrator, der in Ihrer privaten Cloud installiert ist, wurde nicht geändert. Sie können Ihre API-Integrationen, PowerShell oder andere Skripting-Tools wie bisher verwenden, wenn Sie eine Verbindung mit den Orchestrator-Instanzen herstellen.

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.

Hinweis:

Lokale Benutzer können unabhängig von ihrer Rolle auf Organisationsebene API-Zugriffsinformationen für Orchestrator-Dienste anzeigen.

Verzeichnisbenutzer können keine API-Zugriffsinformationen für einen Orchestrator-Dienst anzeigen, wie unten beschrieben. Stattdessen müssen sie eine externe Anwendung registrieren und den OAuth-Flow verwenden.

1. Log in to your Automation Cloud^TM account.
2. Navigieren Sie zu Administrator > Mandanten. Auf der Seite Mandanten werden alle vorhandenen Mandanten aufgeführt.
3. Klicken Sie auf den Pfeil links neben dem gewünschten Mandanten, um die verfügbaren Dienste anzuzeigen.
4. Klicken Sie auf API-Zugriff für den Orchestrator-Dienst. Das Fenster API-Zugang öffnet und inkludiert die folgenden dienstspezifischen Informationen:

• Benutzerschlüssel – Ermöglicht es Ihnen, eindeutige Anmeldeschlüssel zu generieren, die mit APIs oder Anwendungen von Drittanbietern verwendet werden, um sich anzumelden und Aktionen in Ihrem Namen auszuführen. Dies war zuvor als Aktualisierungstoken bekannt.
• Organisations-ID – Ihr Organisationsname. Dies ist der Name nach der Basis-URL.
• Mandantenname – Der Anzeigename des Mandanten.

• Client-ID – bezieht sich auf die Orchestrator-Anwendung selbst und ist für alle Benutzer und Mandanten auf einer bestimmten Plattform identisch. Beispielsweise haben alle Mandanten auf https://cloud.uipath.com denselben Client-ID-Wert.

  
  

  

  
  

Schließen Sie dieses Fenster nicht.Sie benötigen die Informationen, um den Authentifizierungsanruf zu tätigen.Kopieren Sie die Werte, indem Sie auf die Schaltfläche „Kopieren“ neben jedem Feld klicken.

Authenticating to Your Automation Cloud^TM Based Orchestrator Tenant

Der Authentifizierungsvorgang sendet eine POST-Anforderung an https://account.uipath.com/oauth/token. Die Anforderung und Antwort sollten wie im folgenden Beispiel aussehen:

Posten

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

Anforderungsheader

Schlüssel	Wert
Autorisierung	Inhaber

Anforderungstext

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

Antwortcode

200 OK

Antworttext

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

Hinweis: Sie erhalten die Werte {tenant_name}, {client_ID} und {user_key} von Ihrer Seite „API-Zugang“, wie im vorherigen Abschnitt beschrieben.

Kopieren Sie {access_token} zur späteren Verwendung.

Wichtig: Das zum Ausführen von Orchestrator-API-Aufrufen erforderliche {access_token} ist 24 Stunden lang gültig.Sie müssen {access_token} mit Ihrem {refresh_token} wiederherstellen. Andernfalls erhalten Sie den Statuscode 401.

Durchführen von Orchestrator-API-Aufrufen

1. Führen Sie eine GET-Anforderung durch für https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/Settings/UiPath.Server.Configuration.OData.GetLicense
2. Ersetzen Sie {organization_name} und {tenant_name} durch Ihre Werte von der Seite „API-Zugriff“.
3. Legen Sie den Autorisierungsheader auf Bearer {access_token} fest und fügen Sie den Wert {access_token} ein, den Sie im obigen Verfahren erhalten haben.

Nach dem Senden der Anforderung sollten Sie vom Orchestrator eine Antwort mit den Lizenzinformationen für diesen Dienst erhalten.

Die Anforderung und Antwort sollten wie im folgenden Beispiel aussehen:

Abrufen

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

Anforderungsheader

Schlüssel	Wert
Autorisierung	Inhaber

Antwortcode

200 OK

Antworttext

{
    "@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
    }
}

Wichtig:

Alle Orchestrator-API-Aufrufe nach der ersten Autorisierung müssen an die Orchestrator-URL gehen.

Sie müssen den folgenden Header enthalten:

• Authorization: Bearer {access_token}

Für den Zugriff auf Ressourcen in einem Ordner müssen Sie die FolderId oder den FolderPath in einem HTTP-Header hinzuzufügen, wie auf der Seite Erstellen von API-Anforderungen erläutert. Zum Beispiel:

• X-UIPATH-OrganizationUnitId: {FolderId}

Wichtig:

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

Sie können die Parameter $top und $skip in Ihren Anforderungen verwenden, um nachfolgende Seiten abzurufen. Verwenden Sie beispielsweise die Anforderung GET https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/RobotLogs?$top=1000&$skip=2000, um die Roboterprotokolleinträge zwischen 2.001 und 3.000 abzurufen.