SimplAuth

SimplAuth is an authentication protocol used to gain access to various Simployer APIs.

SimplAuth - get started

Prerequisites for using SimplAuth:

  1. You need to be a system administrator in your Simployer tenant. If you are not already a system administrator, contact one of your existing system administrators to provide you with this role.
  2. You need access to to the Simployer Admin Center to create credentials that can be further used to generate tokens using SimplAuth. Create a support ticket with Simployer Customer Care, and they can provide access to the Admin Center (given you are a system administrator). When access to the Admin Center is granted, it will be available in the Global Menu of your Simployer Portal. The Admin Center is free of charge.

Creating API keys

To get data from Simployer APIs, you need to be authenticated. It is handled through access tokens, which can be retrieved using API keys.

Head over to the Admin Center to create a new API client: https://admincenter.simployer.com/

Name your client and ensure you select API you want to have access to.

Next, create a secret for your client:

Important! After the secret is generated, it will be possible to copy it to the clipboard, but only once. Ensure you store this key in a safe place. Do not share this key with anyone — it is your private key to all core data in your Simployer tenant.

Next, move to the Quickstart section (the first tab in the top left corner). Choose selected API and paste the secret in the label. Select your favourite tool: cURL or PowerShell, then copy whole section.

With the given cURL command, use your application of choice to execute the request and obtain a JWT token (access token). In this example, it is Postman.

With the token, you can proceed to fetch data from the API. Please remember that the token is valid for one hour. After that, you will need to execute the cURL command again to obtain a new token.