Apps

How do I register an Application?

When you create an application you are provided with a client ID and client secret for that application. You must supply these credentials when you call an API that requires authentication.

To register an application, click on Apps in the main menu, and then click Create new App. When you have entered an application name and clicked Submit, a client ID and client secret will be generated.

The client secret can only be viewed now; it is important to make a note of it or you will you have to issue a new one next time you wish to make API calls with your app.

What are the Client ID and Client Secret?

The client ID is the public identifier of your application. It's used in every call so we can tell who is requesting information.

The client secret is the private identifier of your application. This allows us to verify your identity in the authentication step of our APIs.

Your client ID and client secret identify you, and are essential to protecting yourself and your customers. Please keep them safe at all times.

How do I reset my Application Client Secret?

Your client secret is stored encrypted, so we cannot retrieve it if you forget it.

If required, you can generate a new client secret for your application, which will replace the stored value and display the new value to you.

To reset your client secret, click Apps in the main menu, select the relevant application, and then click Reset in the Client Secret section.

Your new client secret will be displayed at the top of the page. Again, be sure to note it down as this can only be viewed now.