API-Zugang

Überblick

Mit der Data Fabric/Data Service Open API können Sie^UiPath® Data Fabric/Data Service-Ressourcen über eine externe Anwendung Ihrer Wahl verwalten, indem Sie die externe App über das OAuth 2.0 Autorisierungsframework autorisieren, ohne Anmeldeinformationen freizugeben.

Erfahren Sie, wie Sie eine externe Anwendung registrieren.

API-Berechtigungen

Um die Data Fabric/Data Service OpenAPI zu verwenden, müssen Sie der externen Anwendung API-Berechtigungen erteilen. Diese API-Berechtigungen werden als Scopes bezeichnet und es gibt drei Arten für Data Fabric/Data Service:

• Data Fabric/Data Service.Schema.Read – Dieser Benutzer-Scope ermöglicht es Ihrer externen App, das Data Fabric-/Data-Service-Schema Ihres Mandanten zu lesen, wobei dies von den Berechtigungen des Benutzers abhängig ist.
• Data Fabric/Data Service.Data.Read – Dieser Benutzer-Scope ermöglicht es Ihrer externen App, die Data Fabric-/Data Service-Daten Ihres Mandanten zu lesen, wobei dies von den Berechtigungen des Benutzers abhängig ist.
• Data Fabric/Data Service.Data.Write – Dieser Benutzer-Scope ermöglicht es Ihrer externen App, die Data Fabric-/Data Service-Daten Ihres Mandanten zu bearbeiten, indem sie löscht, aktualisiert oder neue Daten erstellt, wobei dies von den Berechtigungen des Benutzers abhängig ist.

Erfahren Sie mehr über die Benutzerrollen und Berechtigungen in Data Fabric/Data Service.

OpenAPI-Spezifikation herunterladen

Nachdem Sie die Berechtigungen für Ihre externe Anwendung und Benutzer festgelegt haben, laden Sie die OpenAPI-Spezifikation Ihrer Mandanten Data Fabric-/Data Service-Daten herunter:

• Wählen Sie auf der Seite Data Fabric/Data Service die Option API-Zugriff und dann OpenAPI-Datei herunterladen (JSON) aus.

Bei diesem Vorgang werden die OpenAPI 3.0-Spezifikationen Ihrer Mandanten Data Fabric/Data Service-Entitäten im JSON-Format heruntergeladen.

Wenn Sie „OpenAPI-Link kopieren“ auswählen, wird der API-Endpunkt kopiert, der die OpenAPI-Spezifikation des Mandanten Data Fabric / Data Service generiert.

Autorisieren der API-Aufrufe

Autorisieren Sie Ihre externe Anwendung zur Nutzung der Data Fabric/Data Service OpenAPI, indem Sie ein Zugriffstoken für Ihre externe Anwendung erstellen. Verwenden Sie die App-ID und das App-Geheimnis , die bei der Registrierung der externen Anwendung generiert wurden. Die Autorisierungsmethode hängt vom Typ der Anwendung (vertraulich oder nicht vertraulich) ab.

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 Fabric-/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 Fabric-/Data Service API-Endpunkt hat die folgende Syntax:

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

  

Beispiel für die Entität Data Fabric/Data Service

Um die einzelnen API-Anforderungs-/Antworttexte zu beschreiben, verwenden wir die E-Mail -Entitätsfelder, die im Data Fabric/Data Service erstellt wurden. Während wir den exemplarischen Endpunkt dokumentieren, z. B. Get Entity Records, enthält Ihr Endpunkt den genauen Namen Ihrer 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.

Sehen wir uns den Data Fabric/Data Service API-Leitfaden an, um uns mit jedem Endpunkt vertraut zu machen und herauszufinden, wie Sie ihn nutzen können.