Public APIs

The basics

Picture
Picture

Create a new application

  • Select the corresponding API product(s) on the section Products.

  • On the bottom on the API product detail, fill the text box with a name of your desired new App.

  • Accept API Terms and Conditions.

  • Click on the Subscribe button.

  • Your application will be created.

Register an application

In order to call any API you must have a valid subscription key, that you can request by creating an application in Products tab.

This subscription key is used in identifying you and your application, so it must be sent as part of the http request header as Ocp-Apim-Subscription-Key.

Picture

Getting your Subscription Key

From Subscription Management, click on your registered app to go into its detail view. You’ll see a subscription key for each of the selected (and approved) API products. This subscription key is a required request header parameter.

Each product has a different subscription key.

Public API products are automatically approved.

Get request header parameter for Public APIs

Header parameter: Ocp-Apim-Subscription-Key

Value: From your dashboard, click on your registered app to go into its detail view. You’ll see a subscription key for each of the selected (and approved) API products. 

Getting your authentication tokens

The public APIs only need the header parameter                                                              Ocp-Apim-Subscription-Key as authentication token.

Promoting your application to Production

On the top of the page, make sure you are on “Production Environment” 

1. In order to call any API in Production, you must have a valid subscription key, that you can request by creating an application in the tab Products. To do so, select the type of API you want to create a new App.

2. On the bottom of the detail API Product you have already selected, fill the textbox with the desired name of your new App.

3. Accept API Terms and Conditions.

4. Click on the Subscribe button.

5. On the section Subscription Management under the menu Account, you will find your created app with the subscription.

Picture