REST-APIs - Automate_Evolve - Automate_Studio_Manager - Latest

Benutzerhandbuch zu Automate Evolve

Product type
Software
Portfolio
Integrate
Product family
Product
Automate > Automate Studio Manager
Automate > Automate Evolve
Version
Latest
Language
Deutsch
Product name
Automate Evolve
Title
Benutzerhandbuch zu Automate Evolve
Copyright
2024
First publish date
2018
ft:lastEdition
2024-05-23
ft:lastPublication
2024-05-23T16:24:42.750458

REST-APIs ermöglichen die Integration der Composer Lösung in andere Systeme mithilfe der HTTP-REST-API (d. h. das HTTP-Protokoll für den Zugriff auf Daten, das normalerweise als REST-API bezeichnet wird). Nur die REST-APIs, die den Inhaltstyp JSON unterstützen (d. h. APIs mit dem Content-Type-Header application/json und dem Accept-Header application/json) werden unterstützt. Andere Inhaltstypen wie XML, Binärwerte, x-www-form-urlencoded usw. werden nicht unterstützt.

Der Composer-Ersteller kann eine neue Datenverbindung vom Typ REST-API erstellen, und wie jede andere Datenverbindung kann diese Datenverbindung im Lösungsbereich oder in der Verbindungsbibliothek im Anwendungsbereich oder globalen Bereich erstellt werden. Auch die REST-API-Datenverbindung kann mit anderen Funktionen wie „Query-Steuerung,“ „Nachschlagen-Steuerung“, „Webdienststeuerung“, „Teilnehmer-Konfliktlöser“ usw. verwendet werden.

Anmerkung: Es gibt keine lizenzspezifischen Anforderungen für die Verwendung von REST-APIs. Sie können einfach verwendet werden, indem eine Datenverbindung vom Typ „REST-API“ erstellt wird.

Authentifizierung

Anmeldeinformationen für eine API-Verbindung können entweder beim Erstellen einer API-Datenverbindung hinzugefügt werden, dh durch Aktivieren des Schalters mit der Bezeichnung Systemanmeldeinformationen aktivieren oder durch Navigieren zu Datenquellen-Anmeldeinformationen.

  • Systemanmeldedaten aktivieren: Aktivieren Sie diese Umschaltfläche, um die hier bereitgestellten Anmeldedaten für die Authentifizierung zu verwenden. Wenn Anmeldedaten auf Benutzerebene zusammen mit den Systemanmeldedaten hinzugefügt werden, haben die Systemanmeldedaten eine höhere Priorität gegenüber den Anmeldedaten auf Benutzerebene. Bei Aktivierung – Der Benutzer muss Anmeldedaten eingeben, während er eine Datenquellenverbindung auf dieser Seite erstellt. (Benutzername und Passwort werden angezeigt). Bei Deaktivierung – Der Benutzer muss auf der Seite „Datenquelle-Anmeldedaten“ Anmeldedaten eingeben (Benutzername und Kennwort werden ausgeblendet).

  • Anmeldedaten auf Benutzerebene: Sie werden auf Benutzerebene hinzugefügt, indem Sie zur oberen rechten Ecke von Evolve navigieren, auf den Namen des Benutzers klicken und dann Datenquellen-Anmeldedaten auswählen. Der Benutzer kann mit dem Authentifizierungstyp „Standard“, „SAP Hana Standard“ oder „Salesforce“ Anmeldedaten für die REST-API-Verbindung hinzufügen. Das Umschalten der Systemanmeldedaten ist deaktiviert.

Für den Zugriff auf eine beliebige API wäre ein Routenpräfix erforderlich, das eine Kombination aus Evolve URL und bestimmten Schlüsselwörtern ist. Beispiel: <Evolve URL>/svr.

Datenquelle-Anmeldedaten

Hinzufügen

Bei Auswahl von „Hinzufügen“ sollte der Benutzer Anmeldedaten für die Rest-API-Datenverbindung mit dem Authentifizierungstyp „Standard“, „SAP Hana Standard“ oder „Salesforce“ eingeben können. Ferner sind die Systemanmeldedeaten deaktiviert.

Bearbeiten

Wenn Sie „Verbindung bearbeiten“ auswählen, sollte der Benutzer die Anmeldedaten über die Option „Bearbeiten“ bearbeiten können.

Löschen

Wenn Sie eine hinzugefügte Verbindung auswählen, sollte der Benutzer die Anmeldedaten über die Option „Löschen“ löschen können.

Evole APIs im REST-Format, die zur Nutzung verfügbar gemacht werden können

Diese APIs werden mit dem API-Gateway und seinem unterstützten Authentifizierungsmechanismus gesichert.

Für drei Sicherheitsoptionen unter „API-Gateway“ gibt es die folgenden Routenpräfixe, die für den Zugriff auf die API verwendet werden müssen:

Geheimer Clientschlüssel: „<Evolve URL>/svr“

Sicherheitstoken: „<Evolve URL>/svr“

Zertifikat: „<Evolve URL>/svrc“

API-Name HTTP-Methode Weiterleiten Beschreibung
Referenzdaten GET

<Routenpräfix>/api/v1/ReferenceData?AppName=<Anwendungsname>&LibraryName=<Bibliotheksname>&SolutionName=<Referenzdatenlösungsname>

Diese API wird für Access-Daten aus Referenzdatenlösungen verwendet.

Diese API unterstützt zudem den Filter für beschränkte OData.

Lösungsdaten GET <Routenpräfix>/api/v1/SolutionDataSet?AppName=<Anwendungsname>&SolutionDataName=<Lösungsname>

Diese API dient dem Zugriff auf Lösungsdaten.

Diese API unterstützt zudem den Filter für beschränkte OData.

Überwachung (Systemwarnungen) GET <Routenpräfix>/api/v1/Monitoring/SystemAlerts/?NotificationId=<Benachrichtigungs-ID> Diese API gibt Warnungen des Evolve Systems zurück (sofern vorhanden), die auf dem Administrations-Dashboard im Abschnitt „Systemwarnungen“ angezeigt werden.
Überwachung (Entfernen von Systemwarnungen) POST <Routenpräfix>/api/v1/Monitoring/SystemAlerts/Dismiss?NotificationId=<Benachrichtigungs-ID> Diese API dient zum Entfernen/Löschen der Benachrichtigung für die angegebene Benachrichtigungs-ID.