Learn how to create API keys and generate access tokens for Simployer APIs with SimplAuth.

SimplAuth is the authentication protocol used to access Simployer APIs.

Prerequisites for using SimplAuth

To use SimplAuth, you must:

1. Be a system administrator in your Simployer tenant. If you are not a system administrator, contact an existing system administrator to receive the role.
2. Have access to Simployer Admin Center, where you create credentials for generating access tokens with SimplAuth. If you are a system administrator, submit a support request to Simployer Customer Care to request access to Admin Center. Once access is granted, Admin Center is available from the Global Menu in Simployer Portal. Admin Center is free to use.

Create API keys for SimplAuth

You must authenticate before you can retrieve data from Simployer APIs. Authentication uses access tokens generated with API keys.

1. Go to Admin Center to create an API client.
2. Name the client and select the API you want to access.
3. Create a secret for the client.
4. Copy the secret and store it securely. You can copy the secret to your clipboard only once. Do not share the secret with anyone. It is the private key to all core data in your Simployer tenant.
5. Go to the Quickstart tab, which is the first tab in the upper-left corner. Select the API and paste the secret into the field. Select cURL or PowerShell, then copy the entire section.
6. Run the cURL command in a tool such as Postman to retrieve a JWT access token.

Use the SimplAuth access token

Use the SimplAuth access token to retrieve data from the API. The access token is valid for one hour. After one hour, run the cURL command again to retrieve a new access token.