API-Zugang

Überblick

Mit der Open API des Data Service können Sie Ressourcen des UiPath Data Service aus einer externen Anwendung Ihrer Wahl verwalten. Dies geschieht, indem Sie die externe App über das Framework Oauth 2.0 autorisieren, ohne irgendwelche Anmeldeinformationen freigeben zu müssen.

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

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

Wenn Ihre externe Anwendung und die Benutzerberechtigungen eingerichtet sind, laden Sie die OpenAPI-Spezifikation von den Data Service-Daten Ihres Mandanten herunter. Navigieren Sie dazu zum Menü oben rechts auf der Registerkarte ihres Mandanten mit der Bezeichnung Data Service > API-Zugang > OpenAPI-Datei herunterladen (JSON).

Dadurch erhalten Sie die OpenAPI 3.0-Spezifikationen der Data Service-Entitäten Ihres Mandanten im JSON-Format. 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

Um auf die benutzerbezogenen Ressourcen des Data Service zuzugreifen, autorisieren Sie Ihre externe Anwendung mit einer der folgenden Methoden:

• Autorisierungscode (für vertrauliche externe Apps)

• Autorisierungscode mit PCKE (für nicht vertrauliche 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 + Die 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.
  
  

  

  
  

  Im Data Service API-Leitfaden erfahren Sie mehr über jeden Endpunkt und erfahren, wie Sie ihn nutzen können.