An API key will be issued as requested that will be in the form of a 32-bit hexadecimal string. This key will allow anyone with it to access the resources it has been enabled for within the API.

Use in URL

To use the API key in the URL you are requesting, add a query string parameter called 'apiKey' to the URL and assign your API key as it's value e.g.


Use as request header

The API key can also be added to the header of each request by setting the custom header 'X-apiKey' in the request's headers e.g.


IP Authentication

As well as using an API key, IP-based authentication can be used to ensure the API key is only successfuly used from a particular IP range.