API-Schlüssel

Sie verwenden API-Schlüssel, um eine Verbindung zwischen der UiPath®-Plattform und anderen externen Anwendungen herzustellen. Externe Anwendungen können entweder UiPath® Desktop-Anwendungen oder Anwendungen von Drittanbietern sein.

API-Schlüssel sind für mehrere UiPath-Dienste (Produkte) verfügbar.

Wichtig: Die Unterstützung für die API-Schlüssel-Authentifizierung endet im März 2025. Wir empfehlen die Verwendung von externen Anwendungen oder persönlichen Zugriffstoken (PATs) als primäre Authentifizierungsmethode.

Erfahren Sie mehr über Demnächst veraltete Funktionen.

Orchestrator

Über den API-Zugriff

Sie können API-Zugriffsinformationen für jeden Ihrer vorhandenen Orchestrator-Dienste auf der Seite Administrator > Mandanten > Dienste anzeigen.

Diese Informationen sind für die Authentifizierung bei Ihrem Orchestrator-Dienst in der Automation Cloud über API-Aufrufe erforderlich.

Hinweis: Wenn Sie keinen Zugriff auf die Admin-Seite haben, die nur Benutzern zur Verfügung steht, die über die Organisationsadministratorrolle verfügen, dann können Sie API-Zugriffsinformationen von der Seite „Einstellungen“ für Ihr Konto abrufen.

Wichtig:

Gilt nicht für Azure AD

Wenn die Authentifizierungseinstellungen für Ihre Organisation auf die Verwendung einer Verzeichnisintegration festgelegt sind, ist die Schaltfläche API-Zugriff nicht verfügbar und diese Anweisungen gelten nicht für Sie.

In diesem Fall müssen Sie einen der folgenden Schritte ausführen:

Melden Sie sich von der Automation Cloud ab und dann mit einem UiPath®-Konto anstelle eines Verzeichniskontos an oder
(empfohlen) verwenden Sie stattdessen den OAuth-Flow.

Anzeigen von API-Zugriffsinformationen

Sie können die API-Zugriffsinformationen für einen Dienst anzeigen, wenn Sie über die Rolle Organisationsadministrator verfügen oder wenn Sie diesem Dienst zugewiesen sind.

Wechseln Sie zu Administrator und wählen Sie den Mandanten im Bereich auf der linken Seite aus.
Klicken Sie auf Dienste.

Die Seite Dienste wird geöffnet und listet alle vorhandenen Dienste für den ausgewählten Mandanten auf.
Klicken Sie auf der Orchestrator-Karte auf und wählen Sie API-Zugriff aus:
Das Fenster API-Zugang wird mit den folgenden dienstspezifischen Informationen angezeigt:
- Benutzerschlüssel – Ermöglicht es Ihnen, eindeutige Anmeldeschlüssel zu generieren, die von APIs oder Anwendungen von Drittanbietern verwendet werden, um sich anzumelden und Aktionen in Ihrem Namen auszuführen. Dies war bisher als Aktualisierungstoken bekannt.
- Logischer Name des Kontos – Ihr Organisationsname (z. B. myNewOrg).
- Mandantenname – der Anzeigename des Mandanten.
- Client-ID – betrifft die Orchestrator-Anwendung selbst, ist für alle Benutzer und Orchestrator Dienste auf einer bestimmten Plattform identisch. Beispielsweise haben alle Orchestrator-Dienste auf cloud.uipath.com denselben Client-ID-Wert.
Klicken Sie neben einem beliebigen Feld auf das Symbol , um seinen Wert zu kopieren.

Sie können die kopierten Informationen verwenden, um Cloud-APIs zu nutzen.

Widerrufen des API-Zugriffs

Durch das Widerrufen des Zugriffs werden alle zuvor zugewiesenen Benutzerschlüssel ungültig, wodurch alle Anwendungen abgebrochen werden, die zuvor zugewiesene Benutzerschlüssel nutzen. Für den ausgewählten Orchestrator-Dienst wird automatisch ein neuer Benutzerschlüssel generiert.

Sie müssen den neuen Benutzerschlüssel für alle betroffenen Anwendungen freigeben.

Wechseln Sie zu Administrator und wählen Sie den Mandanten im Bereich auf der linken Seite aus.
Klicken Sie auf Dienste.

Die Seite Dienste wird geöffnet und listet alle vorhandenen Dienste für den ausgewählten Mandanten auf.
Klicken Sie auf der Orchestrator-Karte auf und wählen Sie API-Zugriff aus.

Das Fenster API-Zugriff wird geöffnet.
Klicken Sie auf Zugriff widerrufen.

Ein Bestätigungsfenster wird geöffnet.
Klicken Sie auf Widerrufen, um die Aktion zu bestätigen.

Der Wert des Benutzerschlüssels des Dienstes wird widerrufen und das Fenster Aktualisierungstoken widerrufen wird angezeigt.
Schließen Sie das Fenster Aktualisierungstoken widerrufen.
Kopieren Sie den neuen Schlüssel und geben Sie ihn an die Benutzer weiter, die ihn benötigen.

Document Understanding

Der API-Schlüssel für Document Understanding ist auf der Seite unter Administrator > Lizenzen > Verbrauchsmaterialien > AI Units verfügbar:

Von hier aus können Sie:

Kopieren Sie den Schlüssel für die Verwendung in externen Anwendungen.
Klicken Sie auf „Aktualisieren“, um einen neuen Schlüssel zu generieren.
Wichtig: Wird ein neuer Schlüssel generiert, wird der alte Schlüssel ungültig. Externe Anwendungen, die den alten Schlüssel verwendet haben, können keine Verbindung mehr mit der Automation Cloud herstellen.

Weitere Informationen finden Sie unter API-Schlüssel in der Document Understanding-Dokumentation.

Computer Vision

Der API-Schlüssel für Computer Vision ist auf der Seite Administrator > Organisation > Lizenzen > Roboter und Dienste verfügbar:

Von hier aus können Sie:

Kopieren Sie den Schlüssel für die Verwendung in externen Anwendungen.
Klicken Sie auf Aktualisieren, um einen neuen Schlüssel zu generieren.

Wichtig: Wird ein neuer Schlüssel generiert, wird der alte Schlüssel ungültig. Externe Anwendungen, die den alten Schlüssel verwendet haben, können keine Verbindung mehr mit der Automation Cloud herstellen.

Weitere Informationen finden Sie unter Computer Vision.

Auf dieser Seite