Awards Management API Access and Authentication

Access to the Awards Management API requires secure credentials - please contact Symplectic Support to request your unique Client ID and Client Secret for accessing the API.

If you require multiple integrations, you should request additional credentials.

An individual Client ID / Secret can be revoked at any time by contacting Symplectic Support.

To make a request to the API, you must first request a bearer token using the following endpoint

POST /v1/auth/token

Body

{ 
    "clientID": "{YOUR CLIENT ID}", 
    "clientSecret": "{YOUR CLIENT SECRET}" 
}

If successful this will return a bearer token as follows

{ 
    "token": "eyJhbGc..." 
}

Use this token to set the Authorization header for subsequent requests:

Authorization: Bearer eyJhbGc...

You can test this in the Swagger interface by copying and pasting this, and then using the Authorize button to set the header - try the GET /v1/common/address-types endpoint to verify all is working.