All external programs, business applications and the mobile client access Simplifier via Simplifier Client API.
Simplifier Client API is documented by Swagger and can be accessed by opening the URL:
https://<simplifierbaseurl>/client/2.0/api-docs/
A detailed documentation of the client API is displayed and you can try out the API using the tools built into Swagger. All changes in the API are automatically transferred to the documentation.
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}
The Simplifier token must be used for every following API request as header parameter simplifierToken.
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 |
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 |