Was ist die Simplifier Client API?
Simplifier Client API bezieht sich typischerweise auf die Gruppe von Webservices, die auf dem REST-Protokoll basieren und es externen Systemen und Entwicklern ermöglichen, programmatisch mit der Plattform zu interagieren. Dies kann das Erstellen, Aktualisieren und Abrufen von Daten, das Verwalten der Benutzerauthentifizierung und das Auslösen oder Automatisieren verschiedener Ereignisse und Workflows innerhalb der Low-Code-Umgebung umfassen.
Wie finde ich Informationen und wie kann ich sie testen?
Um auf die Simplifier API-Seite zuzugreifen, wählen Sie im oberen rechten Menü den API Explorer aus.
Alternativ kann auf die Simplifier Client API zugegriffen werden, indem die URL geöffnet wird:
https://<simplifierurl>/client/api-docs/
Seit Version 8 Enhancement Package 1 ist es auch möglich, die API über Open API 3.0 Format herunterzuladen, um sie in anderen Middlewares und Anwendungen zu verwenden.
Authentifizierung
Um die API-Aufrufe ausführen zu können, müssen Sie den Benutzer authentifizieren. Derzeit kann nur die Basic Authentication mit den Anmeldedaten eines lokalen Simplifier-Benutzers verwendet werden. Sie haben zwei Möglichkeiten:
- Verwenden Sie die HTTP-Basisauthentifizierung
- Verwenden Sie einen Simplifier-Token
HTTP-Basisauthentifizierung
Um die HTTP-Basisauthentifizierung zu verwenden, müssen Sie den Standard-HTTP-Header-Parameter verwenden Authorization
Authorization: Basic <credentials>
<credentials> ist die Base64-Kodierung von Benutzername und Passwort, die durch einen einzelnen Doppelpunkt (:) verbunden sind. Mit dem folgenden Beispiel können Sie es mit Javascript generieren
const sCredentials = btoa("<username>:<password>");
Simplifer Token
Um einen Simplifier-Token zu generieren, können Sie den folgenden Endpunkt verwenden:
POST https://<simplifierbaseurl>/genToken/
postBody:
{"user": "<username>", "pass": "<password>"}
Beispielantwort:
{"result": "<simplifierToken>", "success": true}
