Precisely

Postman Collection

One of the ways you can send your Precisely API requests is using the Postman app. You can download Postman here as we will be going over the procedure to send API requests using Postman collections. There is also a web version that you can use, but we recommend installing the desktop app.

Precisely API Collections in Postman

In this section, you will learn how to download our API collection .json files, unzip them, and import in Postman. You can download Precisely APIs and Environment files and save them locally. You will be able to download the DIS_APIs_Postman_Collection.zip file. This folder contains the following files:

  1. DIS APIs.postman_collection.json
  2. PRD-EU1.postman_environment.json
  3. PRD-US.postman_environment.json
  4. PRD-AU1.postman_environment.json
  5. PRD-GB1.postman_environment.json

The first file is your API collections file. The others are environment files for US, EU, AU1, and GB1 zones. You are now ready to import Precisely APIs in Postman. Refer to Postman's documentation on Data Import and Export and follow the instructions.

Importing collections

Import all the .json files in one of your Postman workspaces. To import the files:

  1. Open Postman and click Import.
  2. Import each of the .json files by following the import procedure.

Note that Postman will set up your collections in its interface when you import the .json collection files. It will set up your parameters and the requests as well. You will, however, still need to configure your environment in Postman as described in the next section.

Configure your environment

  1. In Postman, click Environments tab.
  2. Import the PRD-EU1.postman_environment.json and PRD-US.postman_environment.json files.
  3. Select the appropriate environment based on your region (US or EU).
  4. Set the environment variables such as apiBaseURL and apiAccessToken with values from your Precisely account.

You are now done setting up APIs in Postman. The next step is to authenticate and start using the APIs. To authenticate your APIs, you must obtain your API key and API secret by accessing the Precisely Developer Portal.

You can see the authentication video (scroll down in the section 'How to Authenticate' to access the video), which explains the process of generating the API key and secret and demonstrates authentication using Swagger. After you generate your API key and API secret, authenticate your API in Postman (see their documentation, Authorization Methods, and follow the instructions).