You can add a Subscription key to a request in 2 ways:

Query parameter:

Added as a query parameter through the Query parameter name value (subscription-key) obtained from the API Subscriptions details page and Subscription key section within Find and Use an API Portal.

You can add the Subscription key to a request through the Query parameter by following these steps:

  1. Select the Params tab for your new Request in Postman.
  2. Go to the API Subscriptions details page and then the Subscription key section within Find and Use an API Portal.
  3. Copy the Query parameter name value. For this example, the value is 'subscription-key'.
  4. Paste that value into the Query Params Key field in Postman.
  5. Go back to the API Subscriptions details page and then the Subscription key section within Find and Use an API Portal.
  6. Copy the Primary key value (select View the link to reveal). It should look something like '01524318b2b948d0a58ef565947289fc'.
  7. Paste that Primary key value into the Query Params Value field in Postman.
  8. Select the Send button. This will return a response for the API that can be viewed within the Response body in Postman. The response will contain various fields and values including headers, any query parameters, response message and timestamp in JSON format within Postman. You can also download the JSON response file.

Header parameter:

Added as a header parameter through the Header name parameter value (Apim-Subscription-Key) obtained from the API Subscriptions details page and Subscription key section.

You can add the Subscription key to a request through the Header parameter by following these steps:

  1. Select the Headers tab from your new Request in Postman.
  2. Go to the API Subscriptions details page and then the Subscription key section within Find and Use an API Portal.
  3. Copy the Header name value. For this example, the value is 'Apim-Subscription-Key'.
  4. Paste that value into the Headers Key field in Postman.
  5. Go back to the API Subscriptions details page and then the Subscription key section within the Find and Use an API Portal.
  6. Copy the Primary key value (click the View link to reveal). It should look something like '01524318b2b948d0a58ef565947289fc'
  7. Paste that Primary key value into the Header's Value field in Postman.
  8. Select the Send button. This will return a response for the API that can be viewed within the Response body in Postman. The response will contain various fields and values including headers, any query parameters, response message and timestamp in JSON format within Postman. You can also download the JSON response file.

If the API Subscription also has a Native OAuth Application-flow, then you will need to obtain an API Subscription token.