API-Zugang

Rufen Sie die Integration Service-API von einer externen Anwendung aus mithilfe der OAuth 2.0-Autorisierung und Integration Service-Scopes auf.

Überblick

Mit der Integration Service-API können Sie mit Integration Service-Ressourcen aus einer externen Anwendung Ihrer Wahl arbeiten. Sie autorisieren die Anwendung über das OAuth 2.0-Framework, sodass sich ein Dienst oder Skript selbst authentifizieren kann, anstatt sich auf eine angemeldete Benutzersitzung verlassen zu müssen, und ohne Anmeldeinformationen freizugeben.

Verwenden Sie sie, um Integration Service aus einer CI/CD-Pipeline aufzurufen, die eine Lösung veröffentlicht oder bereitstellt, die auf einen benutzerdefinierten Connector verweist, oder aus einer codierten App oder einem Agent, der seine eigenen Integration Service-Verbindungen ohne angemeldeten Benutzer erstellen oder verwalten muss.

Der Zugriff ist auf die von Ihnen gewährten Scopes beschränkt. Eine externe Anwendung oder ein Benutzer, der über eine solche handelt, darf diese Berechtigungen nicht überschreiten. Der vorhandene API-Zugriff mithilfe von Benutzertoken ist unverändert.

Erfahren Sie, wie Sie eine externe Anwendung registrieren.

API-Berechtigungen

Um die Integration Service-API aufzurufen, müssen Sie der externen Anwendung API-Berechtigungen erteilen. Diese Berechtigungen werden als Scopes bezeichnet. Fügen Sie sie in der Automation Cloud unter Admin > Externe Anwendungen hinzu, indem Sie Integration Service als Ressource hinzufügen.

Umfang	Gewährt	Verfügbar als
IS.Connections.Read	Lesezugriff auf Verbindungen.	Benutzer-Scope
IS.Connectors.Read	Lesezugriff auf Connectors, einschließlich Herunterladen eines benutzerdefinierten Connectors.	Benutzer-Scope, Anwendungs-Scope
IS.Connector.Exportieren	Nicht verwendet. Kein Endpunkt erfordert diesen Scope.	Keine Angabe

Wichtig:

IS.Connections.Read ist nur ein Benutzer-Scope. Eine externe Anwendung, die sich selbst ohne einen angemeldeten Benutzer authentifiziert, kann sie nicht erhalten.

Nicht vertrauliche Anwendungen können nur Benutzer-Scopes zugewiesen werden. Den Unterschied zwischen den Anwendungstypen und zwischen Benutzer- und Anwendungs-Scopes finden Sie unter Autorisieren externer Anwendungen.

Autorisieren der API-Aufrufe

Autorisieren Sie Ihre externe Anwendung, indem Sie ein Zugriffstoken dafür erstellen. Verwenden Sie die App-ID und das App-Geheimnis, die beim Registrieren der Anwendung generiert wurden. Die Autorisierungsmethode hängt vom Typ der Anwendung ab, vertraulich oder nicht vertraulich.

Erfahren Sie mehr über die Autorisierungsmethoden für externe Apps.

Senden Sie das Token als Bearer-Token für Ihre Anforderungen. Ein Token ist eine Stunde lang gültig. Um die API danach weiterhin aufrufen zu können, generieren Sie ein neues Zugriffstoken oder fordern ein Aktualisierungstoken an.

Ordner-Scope

Eine externe Anwendung muss bei jeder Anforderung einen einzelnen Ordner mit dem Header „X-UIPATH-FolderKey“ anvisieren und benötigt die Berechtigung Connections.View in diesem Ordner. Anforderungen, die den Header weglassen, und Anforderungen, die für alle Ordner fragen, werden abgelehnt.

Eine Verbindung, die in einem anderen Ordner als der Zielordner vorhanden ist, wird als nicht gefunden und nicht als unzulässig gemeldet.

Verfügbare Endpunkte

Der API-Leitfaden dokumentiert derzeit diese Endpunkte:

• Verbindungen abrufen
• Rufen Sie die Verbindung nach ID ab
• Laden Sie den benutzerdefinierten Connector herunter

Bei Antworten auf eine externe Anwendung werden der Verbindungsinhaber, die Elementinstanz-ID, das Abrufintervall und das Bring-Your-Own-App-Flag weggelassen. Die Konfiguration einer Verbindung wird nur an Aufrufer zurückgegeben, die über den Lese-Scope für die Konfiguration verfügen. Geheime Werte wie API-Schlüssel und OAuth-Token werden nie zurückgegeben.

Weitere Informationen zu jedem Endpunkt finden Sie im Integration Service API-Handbuch.