API-Zugang

Überblick

Mit der Open API des Data Service können Sie UiPath^® Data Service-Ressourcen 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.

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:

• Klicken Sie auf der Seite Data Service auf API-Zugang und wählen Sie dann OpenAPI-Datei herunterladen (JSON) aus.

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

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.

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.

Zugriff auf Data Service-Ressourcen mithilfe externer Anwendungen

Konfigurieren detaillierten Zugriffs für externe Apps

Externe Apps verwenden ihre eigenen Client-Anmeldeinformationen, um auf Data Service-Ressourcen zuzugreifen, anstatt sich als ein Benutzer auszugeben.

Wenn eine externe Anwendung eine Aktion innerhalb einer Entität ausführen möchte, prüft Data Service, ob die App über die erforderlichen Berechtigungen verfügt, um auf die entsprechenden Ressourcen zuzugreifen. Da kein Benutzer an der Authentifizierung beteiligt ist, wird beim Anfordern einer Ressource ein Zugriffstoken generiert, das die Zuweisungen überprüft, die Ihre App auf Mandanten- und Entitätsebene hat. Erst nach einer erfolgreichen Validierung erhält die externe Anwendung Zugriff auf die Ressourcen, für die sie Berechtigungen erhalten hat.

Erstellen externer Apps

Führen Sie als Administrator die folgenden Schritte aus, um eine externe App zu erstellen und für den Zugriff auf Data Service-Ressourcen zu konfigurieren:

1. Navigieren Sie in Ihrer Organisation zu Admin > Externe Anwendungen. Die Seite Externe Anwendungen wird angezeigt.

2. Klicken Sie auf Anwendung hinzufügen:

   1. Geben Sie einen Namen für Ihre externe App an.

   2. Wählen Sie den Typ für Ihre externe App aus.

   3. Klicken Sie auf Hinzufügen. Ihre externe App wird in der Liste Externe Anwendungen angezeigt.

Anmerkungen zum dataService.default-Scope Für vertrauliche Anwendungen, denen benutzerdefinierte Data Service-Rollen zugewiesen wurden, müssen Sie den DataService.Default -Scope anfordern. Dieser Scope verwendet ein Zugriffstoken, um die Zuweisungen Ihrer App auf Mandanten- und Entitätsebene zu überprüfen. Erst nach einer erfolgreichen Validierung kann die externe Anwendung auf die Ressourcen zugreifen, auf die sie Zugriff erhalten hat.

Hinzufügen externer Apps zu einem Mandanten

Führen Sie als Data Service-Administrator die folgenden Schritte aus, um einer externen App Zugriff auf alle Entitäten im ausgewählten Mandanten zu gewähren:

1. Navigieren Sie in Ihrer Data Service-Instanz zur Seite Zugriff verwalten .

   

2. Klicken Sie auf der Seite Zugriff verwalten auf die Schaltfläche Rollen zuweisen.

3. Im Bereich Rollen zuweisen :

   1. Geben Sie im Feld Namen hinzufügen den Namen Ihrer externen App ein und wählen Sie ihn dann aus der Liste aus.

   2. Wählen Sie aus der Liste Rollen auswählen die zuvor erstellte benutzerdefinierte Rolle und die Rolle Datenleser aus. Sie können andere Rollen auswählen, die Sie Ihrer externen App zuweisen möchten, aber Datenleser ist eine obligatorische Auswahl.

   3. Klicken Sie auf Speichern. Ihre externe App wird in der Liste auf der Registerkarte Rollen zuweisen angezeigt.

      

Hinzufügen externer Apps zu einer Entität

Führen Sie als Data Service-Administrator die folgenden Schritte aus, um den Zugriff einer externen App auf bestimmte Entitäten zu verwalten:

1. Navigieren Sie in Ihrer Data Service-Instanz zur Seite Zugriff verwalten .

   

2. Klicken Sie auf der Seite Zugriff verwalten auf die Schaltfläche Rolle erstellen .

3. Im Panel Rolle erstellen :

   1. Geben Sie einen Namen für die benutzerdefinierte Rolle an.

   2. Weisen Sie die gewünschten Administratorberechtigungen zu.

   3. Klicken Sie im Abschnitt Datenzugriffsberechtigungen auf Entität hinzufügen, wählen Sie die gewünschte Entität aus und dann die Berechtigungen, die die externe App innerhalb dieser Entität haben kann.

   4. Klicken Sie auf Speichern. Die benutzerdefinierte Rolle für Ihre externe App wird in der Liste auf der Registerkarte Rollen angezeigt.