Was ist die Simplifier Client API?
Die Simplifier-Client-API bezieht sich in der Regel auf die auf dem REST-Protokoll basierenden Webservices, die es externen Systemen und Entwicklern ermöglichen, programmgesteuert 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 kann ich Informationen finden und testen?
Um auf die Simplifier-API-Seite zuzugreifen, wählen Sie im Menü oben rechts den API-Explorer aus.
Alternativ kann die Simplifier Client API durch Öffnen der URL aufgerufen werden:
https://<simplifierurl>/client/api-docs/
Seit Version 8 Enhancement Package 1 ist es auch möglich, die API über das Open API 3.0 Format herunterzuladen, um sie in anderen Middlewares und Anwendungen zu verwenden.
API-Beispiele
Hinweis: Stellen Sie sicher, dass Sie HTTPS unter Schemata ausgewählt haben.
Authentifizierung
URL: https://<simplifierbaseurl>/genToken/ Method: POST postBody:
{"user": "<username>", "pass": "<password>"}
Beispielantwort:
{"result": "<simplifierToken>", "success": true}
Anwendung
| ERHALTEN | /appDeps/{appName} | Abrufen von Abhängigkeiten für die Anwendung |
| ERHALTEN | /Apps/{appName} | Download Anwendung ZIP |
Abhängigkeiten
| ERHALTEN | /appDeps/{appName} | Abrufen von Abhängigkeiten für die Anwendung |
| ERHALTEN | /libs | Alle Bibliotheken auflisten |
Business-Objekt
| BEREITSTELLEN | /business-object/{businessObject}/{method} | Business-Objekt-Methode ausführen |
Ausführung
| BEREITSTELLEN | /business-object/{businessObject}/{method} | Business-Objekt-Methode ausführen |
| BEREITSTELLEN | /Verbinder/{connector} | Konnektor ausführen |
| BEREITSTELLEN | /connector/{connector}/{call} | Connector-Aufruf ausführen |
| BEREITSTELLEN | /pluginSlot/{plugin}/{slot} | Plugin Slot ausführen |
Verbinder
| BEREITSTELLEN | /Verbinder/{connector} | Konnektor ausführen |
| BEREITSTELLEN | /connector/{connector}/{call} | Connector-Aufruf ausführen |
Bitte beachten Sie: Möglicherweise ist auch ein API-Schlüssel erforderlich, um einen Connector-Aufruf auszuführen. Dies hängt davon ab, ob die Option für erhöhte Sicherheit in den Sicherheitseinstellungen aktiviert ist. Ist dies der Fall, muss ein Header-Parameter “SimplifierApiKey” mit dem jeweiligen Schlüssel angegeben werden.
Herunterladen
| ERHALTEN | /Apps/{appName} | Download Anwendung ZIP |
| ERHALTEN | /libs/{libId} | Bibliothek ZIP herunterladen |
Bibliothek
| ERHALTEN | /libs | Alle Bibliotheken auflisten |
Mobiler Client
| BEREITSTELLEN | /log/MobileClient | Allgemeine Nachricht an den Simplifier-Logger senden |
| BEREITSTELLEN | /log/WebView | WebView-Nachricht an die Simplifier-Protokollierung senden |
Beispiel
| ERHALTEN | /anpingen | Abrufen der Standard-Ping/Pong-Nachricht |
| BEREITSTELLEN | /anpingen | Benutzerdefinierte Ping/Pong-Nachricht abrufen |
Plugin (Englisch)
| BEREITSTELLEN | /pluginSlot/{plugin}/{slot} | Plugin Slot ausführen |
Simplifier
| ERHALTEN | /Version | Abrufen der Version des aktuell ausgeführten Simplifier-App-Servers |
