Using Verdigris API with Postman

Before starting:

1. Make sure you have access to the Postman client in one of two ways:
   1. Download the Postman App on your Apple or Windows machine. (does not require a Postman account)
   2. Access Postman using web browser.(requires a Postman account)
2. Make sure you have the latest version of Postman downloaded on your local machine
3. Create a new Verdigris API Key in Verdigris Admin Console.
   See "How to Create or Manage API Keys" for more details.
4. Save the Client ID and Client Secret as "Variables" in Postman

Get Started

1. Under your preferred Workspace, create a New Collection. See example "Verdigris APIs" in the image above.

2. Navigate to “Authorization” tab

3. Enter below values for:

   1. Type: Select "OAuth 2.0"
   2. Add auth data to: Select "Request Headers"
   3. Token: Select "Available Tokens" or skip
   4. Header Prefix: Select "Bearer"
   5. Keep Auto-refresh Token and Share Token fields inactive

Note: For older versions of Postman, you may need to click "Edit token configuration." before proceeding
IGNORE this note, if you are using the latest Postman version (v10 or higher).

4. Scroll Down to Configure New Token and enter below values for:
   1. Token Name: Enter "auto_token"
   2. Grant Type: Select "Client Credentials"
   3. Access Token URL: Enter "https://auth.verdigris.co/oauth/token"
      Note: Copy and pasting a link may introduce angle brackets "< >" at the start and end of the link. Please remove those before saving.
   4. Client ID: Enter your Client ID from the Verdigris Admin Console
      It is highly recommended to use the Postman Variable to store your "Client" credentials
   5. Client Secret: Enter your Client Secret from the Verdigris Admin Console
      It is highly recommended to use the Postman Variable to store your "Client" credentials
   6. Scope: skip; leave it empty
   7. Client Authentication: Select "Send client credentials in body"

5. Scroll down and click "Advanced."
6. Under "Token Request" section, create a parameter by entering below values under:
   1. Key: Enter "audience"
   2. Value: Enter "https://api.verdigris.co/"
      Note: Copy and pasting a link may introduce angle brackets "< >" at the start and end of the link. Please remove those before saving.
   3. Send In: Select "Request Body"

7. Double check all information is entered exactly as indicated in this support article.
8. Click "Save" on the top right of the tab
9. Click "Get New Access Token" at the bottom of the tab

10. An "Authentication complete" dialog box appears to confirm that all authentication settings have been entered correctly.
11. Click "Proceed" or wait for a few seconds to see your newly generated Bearer Token.

12. The value in "Access Token" is also sometimes called a "Bearer Token". Click "Use Token."

The Access Token auto-expires in 60 minutes. Follow steps 9-12 to regenerate a new Access Token.

You can now add New Requests under the "Verdigris" Collection and start Sending API requests to the Verdigris servers. A "200 OK" response is considered a successful query.

Pro Tip: Use "Folders" to organize the key queries. Above image shows a simple example of how a collection of Verdigris APIs could be organized. References for all public Verdigris API endpoints are found in our API Reference section.

If you run into any issues or errors, please take a screenshot and submit a request to your Verdigris Customer Success Manager or to [email protected] with the details of the query you are attempting.