API Explorer

Interactive Documentation and Manual Testing

The list of API endpoints and manual testing can be done at:
To Authorize access and manually interact with the API, follow these steps:
  1. 1.
    Login to your account as an administrator, click Integrations from the top right account menu.
  2. 2.
    Get the ClientId (API Key) and ClientSecret (API Secret) keys.
  3. 4.
    Click the [Authorize] button.
  4. 5.
    Enter the account keys and and click the [Authorise] button to login.
  5. 6.
    Use the [Try it out] button for each endpoint to make the relevant requests.
  6. 7.
    To logout, click the [Authorize] button, then click the [Logout] button
Each endpoint provides the payload/parameters required, the expected results and error codes.