API-Zugang

Überblick

Mit der Data Fabric Open API können Sie^UiPath® Data Fabric -Ressourcen über eine externe Anwendung Ihrer Wahl verwalten. Dies geschieht, indem Sie die externe App über das OAuth 2.0 Autorisierungsframework autorisieren können, ohne Anmeldeinformationen freigeben zu müssen.

Erfahren Sie, wie Sie in der UiPath^® Automation Cloud die externe Anwendung registrieren können .

API-Berechtigungen

Um die Data Fabric OpenAPI 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 Data Fabric:

• Data Fabric.Schema.Read – Mit diesem Benutzer-Scope kann Ihre externe App das Data Fabric -Schema Ihres Mandanten lesen, und es ist von den Berechtigungen des Benutzers abhängig.
• Data Fabric.Data.Read – Mit diesem Benutzer-Scope kann Ihre externe App die Data Fabric- Daten Ihres Mandanten lesen, und es ist von den Berechtigungen des Benutzers abhängig.
• Data Fabric.Data.Write – Mit diesem Benutzer-Scope kann Ihre externe App die Data Fabric- 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 in Data Fabric.

OpenAPI-Spezifikation herunterladen

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

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

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

Wenn Sie OpenAPI-Link kopieren auswählen, wird der API-Endpunkt kopiert, der die Data Fabric OpenAPI-Mandantenspezifikation generiert.

Autorisieren der API-Aufrufe

Gewähren Sie Ihrer externen Anwendung, die Data Fabric 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 Fabric -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 API-Endpunkt hat die folgende Syntax:

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

  
  

  

  
  

  Beispiel für eine Data Fabric -Entität

  Um jeden API-Anforderungs-/Antworttext zu beschreiben, verwenden wir die Entitätsfelder der Olympische Spiele , die im Data Fabric erstellt wurden. 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 Fabric API-Handbuch sehen wir uns jeden Endpunkt genauer an und erfahren, wie Sie ihn nutzen können.