Guide

To gain access to our public APIs, there is a procedure you must follow:

1. Sign up to our developer portal, and verify your account through the email that you will be sent
   Note: This is a fully automated process that you can run through yourself.

2. Log into the developer portal with your verified account

3. Go to the Products page and request access to the api products you want to access

4. Use the API documentation to create or modify your own software to access our APIs

Requesting access to products

When requesting access to products, you must type in a name for your subscription, this is just a textual description that you will use yourself to identify subscriptions.

After a subscription has been approved, you will find the active subscription listed on your profile page, with pertinent details.

Some subscriptions will be automatically approved by the system, like the Test subscription which contain health check and test APIs, others will require manual approval by us, as they give access to data that may be more sensitive in nature. There may be contracts and agreements that have to be put in place before such approval can be granted.

Calling the APIs

To call our APIs, you must provide your subscription ID, which is per-product. Your active subscriptions on your profile page will contain these IDs.

To provide the ID, add a header to your request with the name `Ocp-Apim-Subscription-Key`, with the value from your subscription.

If you don't provide this subscription ID, all requests to our APIs will fail with a 401 Unauthorized response.