How can I test an API?

It is possible to test an API from the Developer Portal.

When looking at the details of an API, you will see a table of the operations contained in the API. This will show what method they use (GET, POST, PUT, DELETE, PATCH, HEAD or OPTIONS) and what path the resource uses.

If you select the resource, you will see more information about it: which parameters it may take, what it returns, what possible return codes it may use and what they mean.

There is also a ‘Try’ button which enables you to try the resource out directly from the Developer Portal.

If the API requires a Client ID or a Client Secret for identification, you can specify these at the top of the ‘Try’ section.