To gain access to our API's and begin developing an integration, you will need to register an account. By registering an account, you will gain access to the developer portal where you will be able to create, maintain and update your applications.
Requesting access
Currently, access to our developer portal is via invitation only. You can submit an expression of interest by filling in the following form. Once your expression of interest has been approved, you will receive a code that will allow you to register an account on the developer portal.
Getting a client key and secret
Once logged in to the developer portal, you will be able to create a new OAuth application. All integrations utilise OAuth for authentication, and setting up a client application will allow you to interact with our API's.
We currently support two types of OAuth applications:
| Type | Use case | Grant type |
|---|---|---|
| Client credentials | This type of application is well suited for clients with direct access to our applications and where the requirement for direct user impersonation is not present | Client Credentials |
| Authorization code | This type of application is well suited for integrators without direct access to our applications, where services are provided for users of our applications | Auth code |
Depending on your use case, you will need to create an OAuth2 application and make sure you select the correct grant type. Your application will be assigned a unique client identifier, and you can then generate a client secret. The client secret is private and should not be shared.