Testing an API

Let's look at an example of testing an API consumption using Postman. There are other tools that you can use for testing.

Example:

1. Open the Postman application on your desktop or go to the Postman web portal.
2. Login into your Postman account.
3. Create a new request within Postman.
4. Select the operation method you wish to test from the available method dropdown list. This will depend on the operation method available for that API endpoint. In this example, it is the GET method. And you can confirm is it available for that API by reviewing the Operations section of the API definition page within Find and Use an API Portal.
5. Copy the Base URL from the API's Overview and details page within the Environments section within the Find and Use an API Consumption Portal.
6. Paste that Base URL into the Request textbox within Postman.
7. Go back to the API Overview and details page within the Operations section within the Find and Use an API Portal.
8. Copy the URL template value. For example, '/info'. This represents the operation you are about to test using the GET method.
9. Paste that URL template value into the Request textbox in Postman - appended to the end of the Base URL string you already have in Request textbox.
10. Add the Subscription key. If the API has OAuth Application-flow, then you will also need to obtain an API Subscription token.
11. Select the Send button to submit the request.