API-Zugang

Überblick

Data Service Open API allows you to manage UiPath^® Data Service resources from an external application of your choice, and does so by enabling you to authorize the external app without sharing any credentials, through the Oauth 2.0 authorization framework.

Learn how to register the external application in UiPath^® Automation Cloud.

API-Berechtigungen

Um die OpenAPI des Data Service verwenden zu können, müssen Sie der externen Anwendung API-Berechtigungen gewähren. Diese API-Berechtigungen werden als Scopes bezeichnet und es gibt drei Typen davon für den Data Service:

DataService.Schema.Read – Mit diesem Benutzer-Scope kann Ihre externe App das Data Service-Schema Ihres Mandanten lesen, und es ist von den Berechtigungen des Benutzers abhängig.
DataService.Data.Read – Mit diesem Benutzer-Scope kann Ihre externe App die Data Service-Daten Ihres Mandanten lesen, und es ist von den Berechtigungen des Benutzers abhängig.
DataService.Data.Write – Mit diesem Benutzer-Scope kann Ihre externe App die Data Service-Daten Ihres Mandanten bearbeiten, indem sie neue Daten löscht, aktualisiert oder erstellt, und es ist von den Berechtigungen des Benutzers abhängig.

Erfahren Sie mehr über die Benutzerrollen und Berechtigungen im Data Service.

OpenAPI-Spezifikation herunterladen

Sobald Sie die Berechtigungen für Ihre externe Anwendung und Ihre Benutzer festgelegt haben, laden Sie die OpenAPI-Spezifikation von Ihren Data Service-Mandantendaten herunter:

On the Data Service page, click API Access, then select Download OpenAPI file (JSON).

Bei diesem Vorgang werden die OpenAPI 3.0-Spezifikationen Ihrer Data Service-Mandantenentitäten im JSON-Format heruntergeladen.

Wenn Sie auf OpenAPI-Link kopieren klicken, wird der API-Endpunkt kopiert, der die Data Service OpenAPI-Spezifikation des Mandanten generiert.

Autorisieren der API-Aufrufe

Gewähren Sie Ihrer externen Anwendung, die Data Service OpenAPI zu verwenden, indem Sie ein Zugriffstoken für Ihre externe Anwendung erstellen. Verwenden Sie die App-ID und den Geheimen App-Schlüssel, die bei der Registrierung der externen Anwendung generiert wurden. Die Autorisierungsmethode hängt vom Typ der Anwendung ab (vertrauliche oder nicht vertrauliche Anwendung).

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

API-Endpunkte

Das Autorisierungsframework OAuth2.0 unterstützt Sie dabei, ein Zugriffstoken zu generieren, mit dem Ihre externe Anwendung REST API-Aufrufe an Data Service-Endpunkte für eine begrenzte Zeit (eine Stunde) ausführen kann. Um die APIs weiterhin aufrufen zu können, müssen Sie ein neues Zugriffstoken generieren oder ein Aktualisierungstoken anfordern.

Ein Data Service API-Endpunkt hat die folgende Syntax:

HTTP-Methode + BasisURL + Die Ressourcenkategorie + Data Service-Entität + Der Vorgang + Pfadvariablen und Abfrageparameter

Beispiel für eine Data Service-Entität

Um jeden API-Anforderungs-/Antworttext zu beschreiben, verwenden wir die im Data Service erstellten Entitätsfelder der Olympische Spiele .

Während wir den exemplarischen Endpunkt dokumentieren, z. B. Get Entity Records, enthält Ihr Endpunkt den genauen Namen der Entität (z. B. Get Olympics Records). Die Antwort- und Anforderungstexte enthalten alle Felder aus Ihrer Entität und kopieren die Struktur der Entität.