Erste Schritte mit externen APIs

Auf dieser Seite erfahren Sie, wie Sie Ihren ersten authentifizierten API-Aufruf an UiPath durchführen. Es verwendet den Flow der Client-Anmeldeinformationen mit einer vertraulichen externen Anwendung – dem empfohlenen Ausgangspunkt für Produktionsskripte, administrative Automatisierung und Integrationsarbeit.

Hinweis:

Auswählen des richtigen Tools

Mit der UiPath Swagger-Dokumentation können Sie verfügbare API-Endpunkte erkunden und Anforderungs- und Antwortformate interaktiv in einem Browser verstehen. Verwenden Sie Swagger nur für die Erkennung und manuelle Tests. Verwenden Sie für Produktionsautomatisierung, Skripting und Integration Postman, cURL oder Ihren Anwendungscode – diese unterstützen den vollständigen OAuth 2.0-Bearer-Token-Flow, der zur Autorisierung von Anfragen an UiPath APIs erforderlich ist.

Voraussetzungen

• Ein UiPath-Organisationsadministrator hat eine vertrauliche externe Anwendung mit dem Gewährungstyp Client-Anmeldeinformationen registriert und ihr die erforderlichen Scopes zugewiesen.
• Sie haben die App-ID und das App-Geheimnis für die registrierte Anwendung.

Informationen zum Registrieren externer Anwendungen und zur Auswahl des richtigen Gewährungstyps finden Sie unter Externe Anwendungen (OAuth).

Schritt 1: Abrufen eines Bearer-Tokens

Senden Sie eine POST-Anforderung an den Identity Server-Tokenendpunkt, um ein Bearer-Token zu erhalten.

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

Ersetzen Sie die folgenden Platzhalter:

Platzhalter	Wert
{organizationName}	Ihren Organisationsnamen, wie er in der Automation Cloud-URL angezeigt wird
{app_id}	Die App-ID aus Ihrer Registrierung der externen Anwendung
{app_secret}	Das App-Geheimnis aus Ihrer externen Anwendungsregistrierung
{scopes}	Durch Leerzeichen getrennte Liste der Scopes, die der Anwendung gewährt wurden, z. B.: OR.Users.View PM.Users

Die Antwort gibt ein Bearer-Token zurück:

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

Kopieren Sie den Wert access_token . Das Token ist eine Stunde lang gültig.

Hinweis:

Wenn Sie Postman oder ein ähnliches Tool verwenden, legen Sie den Inhaltstyp der Anforderung auf application/x-www-form-urlencoded fest.

Schritt 2: Aufrufen eines API-Endpunkts

Fügen Sie das Bearer-Token in den Authorization -Header Ihrer API-Anforderung ein.

Im folgenden Beispiel wird eine Liste von Maschinen aus Orchestrator abgerufen:

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

Ersetzen Sie {tenantName} durch den Namen Ihres Orchestrator-Mandanten und {access_token} durch das Token aus Schritt 1.

Ergebnis

Eine erfolgreiche Anforderung gibt HTTP 200 mit den angeforderten Daten im JSON-Format zurück.

Wenn die Anforderung fehlschlägt, überprüfen Sie Folgendes:

• Das Token ist nicht abgelaufen. Token laufen nach einer Stunde ab – wiederholen Sie Schritt 1, um ein neues Token anzufordern.
• Der Authorization Header-Wert ist genau wie Bearer {access_token} formatiert.
• Die Ihrer externen Anwendung gewährten Scopes decken den angeforderten Endpunkt ab. Um die Scope-Werte für einen bestimmten Endpunkt zu finden, überprüfen Sie die Dokumentationsseite dieses Endpunkts in diesem Handbuch, insbesondere im Kapitel „Plattformverwaltungs-APIs“ .

Nächste Schritte

• Alle OAuth-Gewährungstypen und -Flows – einschließlich Autorisierungscode und PKCE für den benutzerdelegierten Zugriff – finden Sie unter Externe Anwendungen (OAuth).
• Alle für die Authentifizierung verwendeten Identity Server-Endpunkte finden Sie unter UiPath Identity Server-Endpunkte.
• Informationen zum Strukturieren von API-Endpunkt-URLs finden Sie unter URL-Struktur des API-Endpunkts.