Skip to main content

Setup Postman

Get Postman​

  1. Download and install Postman

Import ACV APIs collection​

  1. Open Postman
  2. Import ACV APIs Postman collection by copying the link address Import Postman Collection
  3. Paste the link copied from step 2. into the input box highlighted below. ImportLink

Postman environment​

Postman environments allow you to store and manage environment variables that can be used across requests in a workspace. We have provided a list of necessary environment variables for making requests against ACV APIs. Follow the instructions below to create a Postman environment and add the necessary variables.

Configuring ACV APIs Postman environment​

  1. Create a new environment in Postman Create Postman Environment
  2. Add the following variables to the Postman environment
SNAPSHOTS_BASE_URL=https://snapshots-rest-api.aptivcs.com
AZURE_TENANT_ID=4ea0a50e-341e-4eb1-9c44-88b724ac50c4
APPLICATION_CLIENT_ID=client credentials id
APPLICATION_CLIENT_SECRET=client credentials secret
ACV_TENANT_ID=
ID_SNAPSHOT=The id of the snapshot to analyze, e.g 255
VEHICLES_BASE_URL=https://vehicleapiv2.aptivcs.com

Authentication​

After successfully filling out the environment in Postman, you need to fetch an access token using Postman. Each sub-directory (e.g., ACV APIs > Vehicles > Authorization) in the root collection contains an authorization tab that requests a token for all directories beneath it. The imported collection contains a pre-setup authorization configuration that will use the environment variables to fetch a client_credentials access token.

  1. In Postman, navigate to ACV APIs > Vehicles > Authorization Vehicle API Auth
  2. Scroll to the bottom and click on "Get New Access Token"
  3. Select "Use Token" after making a request for the access token. This will save the token to the authorization tab and allow you to make authorized requests under that API's sub-directory.