How to Use Postman to Test API Calls [Step-by-Step guide]

Modified on Wed, 22 Jan at 6:03 PM

This article will guide you through the process of using Postman to test Techdinamics' Application Programming Interfaces (APIs).

GETTING STARTED

Before you can start testing APIs, you will need to:

Obtain API credentials
Select the method you would like to test

You can find the API credentials and method information for each Teachdinamics' product API in the following resources:

WARNING: API credentials are sensitive and should be handled securely. Avoid sharing or exposing them.

TEST API CALL

To test an API call on a method of your choice:

1. Select the corresponding HTTP method and enter the corresponding API URL.

NOTE: When calling an API method, combine the portal's base URL with the API method's endpoint. E.g.: If your portal is https://myportal.techdinamics.io and the API method's endpoint is /api/v2/category-x/method-y, the URL to be used for calling that API method will be https://mycompany.techdinamics.io/api/v2/category-x/method-y

2. Add the corresponding mandatory keys.

3. From the Headers tab, add the mandatory API credentials.

4. Press Send.

If the execution is successful, the API will return a response with a status code of 200:

If the execution fails, the API will return a different status code. This code can be used to identify what went wrong. Review the response code and headers for details on the issue and guidance on how to resolve it: