What is the Simplifier Client API?
Simplifier Client API typically refers to the set of Webservices, based on REST Protocol, that allow external systems and developers to interact programmatically with the platform. This can include creating, updating, and retrieving data, managing user authentication, and triggering or automating various events and workflows within the low-code environment.
As an alternative, Simplifier Client API can be accessed by opening the URL:
https://<simplifierurl>/client/api-docs/
Since Version 8 Enhancement Package 1, it is also possible to download the API via Open API 3.0 Format for using it into other middlewares and applications.
API Examples
Note: Make sure that you have select HTTPS under schemes.
Authentication
URL: https://<simplifierbaseurl>/genToken/
Method: POST
postBody:
{"user": "<username>", "pass": "<password>"}
Example Response:
{"result": "<simplifierToken>", "success": true}
Application
GET | /appDeps/{appName} | Get dependencies for application |
GET | /apps/{appName} | Download application ZIP |
Dependencies
GET | /appDeps/{appName} | Get dependencies for application |
GET | /libs | List all libraries |
Business Object
POST | /business-object/{businessObject}/{method} | Execute Business Object Method |
Execution
POST | /business-object/{businessObject}/{method} | Execute Business Object Method |
POST | /connector/{connector} | Execute Connector |
POST | /connector/{connector}/{call} | Execute Connector Call |
POST | /pluginSlot/{plugin}/{slot} | Execute Plugin Slot |
Connector
POST | /connector/{connector} | Execute Connector |
POST | /connector/{connector}/{call} | Execute Connector Call |
Please Note: An API key may also be required to execute a connector call. This depends on whether the option for enhanced security is enabled at the Security Settings. If this is the case, a header parameter “SimplifierApiKey” must be specified with the respective key.
Download
GET | /apps/{appName} | Download application ZIP |
GET | /libs/{libId} | Download library ZIP |
Library
GET | /libs | List all libraries |
Mobile Client
POST | /log/MobileClient | Post general message to simplifier logger |
POST | /log/WebView | Post WebView message to simplifier logger |
Example
GET | /ping | Get default ping/pong message |
POST | /ping | Get custom ping/pong message |
Plugin
POST | /pluginSlot/{plugin}/{slot} | Execute Plugin Slot |
Simplifier
GET | /version | Get the version of the currently running Simplifier app server |