How can I test an API?

Is it possible to test an API before signing up to a plan?

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

When looking at the details of an API you will see a table of the Resources contained in the API. This will show what method they are (GET, POST, PUT or DELETE) and what path the Resource uses.

If you click on the Resource you will see more information about it, what parameters it might take, what it returns, what possible return codes it might use and what they mean.

There is also a 'Try it out' button which enables you to try the Resource out direct from the Developer Portal.

If the API requires a client ID or a client secret for identification then you can specify these at the top of the 'API Resources' section.

Tip: For methods that have request body content you can click on the model schema on the right hand side to prepopulate the body field with the example content, then you can edit it as required.

categories: