Simplifier Client API

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.

How can I find information and test it?

To access the Simplifier API Page, choose the API Explorer in the upper right menu.

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.

Authentication

To be able to execute the API calls, you need to authenticate the user. Currently, only Basic Authentication with credentials of a local Simplifier User can be used. You have two options:

Use HTTP Basic Authentication
Use a Simplifier Token

HTTP Basic Authentication

To use HTTP Basic Authentication, you have to use the standard HTTP header parameter Authorization

Authorization: Basic <credentials>

<credentials> is the Base64 encoding of username and password joined by a single colon (:). With the following example, you can generate it with Javascript

const sCredentials = btoa("<username>:<password>");

When using the API within Simplifier via a Connector, just create a Login Method from type ‘Username or Password’ and add it to your endpoints. Simplifier will add the header parameter automatically during the call execution. Use this solution, if you need to access the API with a generic user. Else use the Simplifier Token alternative.

Simplifer Token

To generate a Simplifier Token, you can use the following endpoint:

POST https://<simplifierbaseurl>/genToken/

postBody:

{"user": "<username>", "pass": "<password>"}

Example Response:

{"result": "<simplifierToken>", "success": true}

The Simplifier token has to be used as a header parameter simplifierToken.

When using the API within Simplifier via a Connector, just create a Login Method from type ‘Token’ with Source ‘Source referenced by the System’ and target header param ‘SimplifierToken’ and add it to your endpoints. Simplifier will add the header parameter automatically during the call execution. Use this solution if you need to access the API with the current user’s token.