You can subscribe to an API within a specified environment by following these steps:

  1. Find the API you wish to subscribe to by following the steps detailed in the Finding an API section of this guide.
  2. Select the API name. This will show you the API Overview page with details of the API.
  3. Select the Subscribe link next to the relevant environment (Dev, Staging, or Live) within the Environments section.
  4. Enter a name for the subscription in the Subscription name textbox to help you identify and differentiate it from others you might create. This is because you can have multiple subscriptions for the same API to different environments or multiple subscriptions for the same API to the same environment.
  5. Enter a justification for your subscription in the Justification for usage textbox. This describes why you require the API subscription.
  6. Select the Create subscription button to submit the subscription request. Or the Return to API link to cancel and return to the API Overview page.

If your chosen API environment requires subscription approval before it is activated, there will be a message to tell you that. And upon submission, your subscription request will be reviewed by the API provider and the relevant permission granted. In the case where approval is not required to subscribe to an API environment, a justification will still have to be provided (for record purposes only) and the subscription will be created immediately.