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 über das Ö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/ Methode: POST postBody:
{"user": "<username>", "pass": "<password>"}
Beispielantwort:
{"result": "<simplifierToken>", "success": true}
Anwendung
| GET | /appDeps/{appName} | Abhängigkeiten für die Anwendung abrufen |
| GET | /apps/{appName} | Anwendung ZIP herunterladen |
Abhängigkeiten
| GET | /appDeps/{appName} | Abhängigkeiten für die Anwendung abrufen |
| GET | /libs | Alle Bibliotheken auflisten |
Business-Objekt
| POST | /business-object/{businessObject}/{method} | Business-Objekt-Methode ausführen |
Ausführung
| POST | /business-object/{businessObject}/{method} | Business-Objekt-Methode ausführen |
| POST | /Konnektor/{connector}Konnektor | ausführen |
| POST | /connector/{connector}/{call} | Connector-Aufruf ausführen |
| POST/pluginSlot/{plugin}/{slot} | Plugin-Slot ausführen |
Verbinder
| POST | /Konnektor/{connector}Konnektor | ausführen |
| POST | /connector/{connector}/{call} | Connector-Aufruf ausführen |
Bitte beachten Sie: Möglicherweise ist auch ein API-Schlüssel erforderlich, um einen Konnektoraufruf 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 entsprechenden Schlüssel angegeben werden.
Herunterladen
| GET | /apps/{appName} | Anwendung ZIP herunterladen |
| GET | /libs/{libId} | Bibliothek ZIP herunterladen |
Bibliothek
| GET | /libs | Alle Bibliotheken auflisten |
Mobiler Client
| POST/ | log/MobileClient | Allgemeine Nachricht an den Simplifier-Logger senden |
| POST/ | log/WebView WebView-Nachricht | an Simplifier-Logger senden |
Beispiel
| GET | /ping | Standard-Ping/Pong-Nachricht abrufen |
| POST/ | ping | Benutzerdefinierte Ping/Pong-Nachricht abrufen |
Plugin (Englisch)
| POST/pluginSlot/{plugin}/{slot} | Plugin-Slot ausführen |
Vereinfacher
| GET | /Version | Abrufen der Version des aktuell ausgeführten Simplifier-App-Servers |
