Configuring OAuth2 on Postman

The following guide shows how to configure Postman to authenticate against and use the API

This guide will assist you in configuring Postman to utilize OAuth2 for token acquisition, enabling you to query an API.

1. Introduction

By following the outlined steps, you can authenticate and access API functionalities within Postman.

2. Set up an environment in Postman

Configure the base Url to the API endpoint provided in the welcome email.

3. Set the the Client Id

Set the client Id to the client Id provided in the welcome email

4. Set the client secret

Set the client secret the to client secret in your welcome email.

5. The the auth url

Set the auth url to the auth url in your welcome email

6. Click "Collections"

Access your collections

7. Download the Postman collection

Download the postman collection from https://apidocs.resharmonics.com and open the collection in Postman. Click on the top level of the collection.

8. Click the Authorization Tab

Click the authorization tab on the collection, set the grant type to Client Credentials and set the Access Token URL to the {{authUrl}} set up in the environment.

9. Set the Client Id

Set the Client Secret to use the {{clientSecret}} set up in the environment.

10. Set the Client Secret

Set the Client Secret to use the {{clientSecret}} set up in the environment.

11. Set the Scope

Set the scope to be "api/read api/write"

12. Generate the Access Token

Click Generate a new access token to create a new access token, the token will last for 60 minutes.

13. Click "Proceed"

Proceed with the token generation process

14. Click "Use Token"

Utilize the generated token

15. Refreshing the Token

The token will last for 60 minutes, you can refresh the token in Postman using the refresh button

16. Test the API access

Select a call from the collection, a good starting point is the first search API.

17. Send first query

Uncheck the Query params or set the to appropriate parameters and click Send.

This guide covered configuring Postman to use OAuth2 for token retrieval and subsequently querying an API by utilizing the obtained token