Using our APIs

I'd like to try an API - What are Plans?

A plan is a collection of resources from one or more APIs. A plan can consist of a mixture of operation types (e.g. GET, POST) from different APIs. Plans have rate limits that determine how many requests an application is allowed to make during a specified time interval. Plans can have a common rate limit for all resources, or each resource can have a different rate limit.

You can use this portal to browse the different plans and select one that is most suitable for your requirements. Some plans are available to use straight away, and some are restricted. You can request access to use a restricted plan - we will assess your request and may contact you for more details.

How can I see my API usage?

The number of requests that your application has made to each API is shown on your application page.

Click Apps in the main menu and then click on your application. In the Product Subscriptions table you will see all plans to which your application is subscribed.

For each API under a given plan you can see your usage compared to the rate limit of the plan.

How can I test an API?

It is possible to test an API from this Portal.

When looking at the API details you can see a list of the available operations, including the method and path that can be use to invoke the operation.

Clicking on the operation in the left-hand menu shows detailed information including parameters that it expcets, what it returns, and possible response codes along with their meanings.

There is also a Call Operation button on the API details page which allows you to invoke the operation directly from the developer portal.

If the API requires a client ID and client secret then you can enter these credentials in the Parameters section above the Call Operation button.