Using Tufin REST API with Postman

Overview

Postman is an HTTP client that can be used for testing web services. Each release, Tufin provides a repository of REST API collections that can be imported into Postman. After importing you will be able to browse the APIs and their documentation, which includes implementation notes, parameters, usage example and response messages (when applicable).

When relevant an example body is also provided, you can alter this body to your needs.

Downloads and Configurations

1. Download and install the Postman extension (click here for procedure)

   1. Navigate to www.getpostman.com.

   2. Choose any OS.

   3. Run the downloaded installation.

2. Download the Postman collections for Tufin REST APIs. Click here to start the download.

3. Add Tufin API Collections to Postman (click here for procedure)

   1. Open Postman.

   2. From the top -left of the screen, click Import.

      

   3. Import the Tufin REST API unzipped files.

      The Postman application displays the imported collections.

4. Adjust the Postman environment variables to match your current TOS version (click here for procedure)

   When you select an API for execution, the URL details are displayed:

   

   The URL may include postman environment variables surrounded by double-curly brackets, as shown above.

   To adjust the variables:

   1. From the environment dropdown on the top- right of the screen, select the Tufin environment.

      Example

      

   2. Click and then Edit.

      

   3. Customize the variables to your current TOS environment.

   4. Click Save and then close the window.

5. Enter authorization details (click here for procedure)

   

   1. Navigate to the Authorization tab.

   2. From the Auth Type menu, select Basic Auth.

   3. Enter your username and password.

   4. Optional: Click Save.

6. Disable SSL Certification (click here for procedure)

   If you don’t see the SSL certification line in the setting screen, confirm that you are not using the Chrome extension

   1. Click and choose Settings.

   2. Turn SSL certificate verification off.

      

   3. Close the settings window.

   4. Restart the Postman application.

Optional Configurations, Per API Call

Modify the API body to include custom data

GET and DELETE APIs don't require a body, but POST, PUT, and PATCH APIs do. Tufin collections provides a predefined body for many of these APIs, which you can edit according to your company needs.

1. Select the API whose body you wish to edit.
2. Navigate to the Body tab (see above image).

3. Edit the body to include your custom data.

4. To modify the content type, see Modify API Format.

5. Click Save .

Modify API Format

From the Header tab, you can configure the input and output formats of the API:

Content-type: The input format

Accept: The desired format of the returned information.

Set Parameters

1. Click Params.

2. Enter the parameter (key, value) pairs.

   Ensure you enter the parameters in the correct location.

3. Click Save.

Call an API

1. From the sidebar, click the API you wish to call.
2. For API details, click the documentation icon in the right-hand side bar.

   

3. Click Send.

   The call results appear.