Setting Up Postman & Postman Environments

Prior to sending requests to Vault API, you must set up Postman with your desired version of the Vault Platform Postman Collection and prepare an environment.

Importing Collections

Section link for Importing Collections

To import the Vault Platform Postman Collection:

1. Create a Postman account.
2. Download the Postman desktop app.
3. Download the Vault Platform Postman Collection from your applicableGAversion of the Vault API Reference by selecting Run in Postman in the lefthand sidebar, then clicking the Run in Postman button. Postman collections are available for Vault API versions v20.2+.
4. Drag and drop the downloaded .json file into your Postman desktop app to import the collection. Alternatively, you can click () > Import.
   

Once imported, the Vault Platform Postman Collection appears in the lefthand sidebar beneath Collections. Click the name of a specific Postman Collection or its folders to expand or collapse the content nested within the collection.

Using Environments

Section link for Using Environments

Environments are reusable sets of stored variables that Postman references when you send requests to Vault API. For example, when sending a request, instead of indicating the vaultDNS and version as path parameters in Postman, you can store these variables and their values in an environment named after a specific Vault. Learn more about managing environments in the Postman Docs.

Download the sample Postman environment we've provided below or continue to the next section to learn how to create an environment.

Download Sample Postman Environment

Creating an Environment

Section link for Creating an Environment

To create an environment for a specific Vault:

1. In Postman, click (), then select Environments.
2. Populate a name for the environment. We recommend naming the environment after the name of your Vault.
3. Populate a Value for each of the following variables:
   • vaultDNS: The DNS of your Vault. For example, myvault.veevavault.com.
   • version: The Vault API version. For example, v26.2.
   • accessToken: Your API access token, beginning with veeva-vault- followed by a randomized string.
   • clientId: The optional client ID for tracking purposes. For example, veeva-vault-tools-server-loader.

Note

Since access tokens are specific to a single Vault, the vaultDNS indicated when creating your Postman environment must match the Vault from which you generated the access token.

Postman automatically saves any changes to these variables. To activate this environment prior to sending calls to Vault API, select No Environment from the top right, then select the environment you created.

Tip

To mask a specific variable, such as your accessToken, hover over the variable and select the key icon to Mark as sensitive.

Switching Environments

Section link for Switching Environments

A single environment can be active at a time, denoted by a next to its name in the list of Environments in the lefthand sidebar. When you send requests to Vault API, Postman uses the variables stored in the active environment. There may be instances where you need to switch between environments, such as testing an endpoint in multiple sandbox Vaults or testing on behalf of multiple users.

To set an environment as active, hover over its name in the lefthand sidebar and select . To set an environment as inactive, hover over the current active environment and select . Alternatively, you can select an environment to be active from the dropdown in the top right.