POSTMAN TOOLKIT

To optimize, test and verify your Yahoo DSP API calls, install and configure the Postman HTTP client in order to build and handle HTTP requests (GET, PUT, POST, and DELETE calls) to the DSP RESTful APIs.

Follow the steps outlined in the sections below to get started.

Install and Configure Postman

Install Postman as a Chrome, Windows, Linux or MacOS app. The best strategy for working with Postman is to get the desktop client. The Chrome version, however, will run on any platform and is identical in functionality and appearance.

Step 1. Install Postman

Begin by installing Postman at https://www.postman.com/downloads/

Once the download is complete, launch Postman.

Step 2. Create a new workspace

In the app, select Workspaces > Create Workspace.

In this document, we’ll use a Workspace called Yahoo Postman API Toolkit.

Step 3. Access the Yahoo DSP API collection

Get access to the Yahoo DSP API collection and select which version of Postman you have. After that, Postman will automatically open and ask you to import the collection.

Step 4. Select the Workspace

Select the desired workplace and click the Import Button. After a few seconds your import is now complete.

Step 5. Set up the DSP Environment

In this series of steps, we will create a Postman Environment and configure the environment with your client_id and client_secret.

If you haven’t generated your client secret and ID, follow the steps outlined in this section in the Setup & Access Guide.

1. Click the eye icon next to the No Environment dropdown and then click the Add link within the Environment section.

   

2. Name the Environment DSP and fill in the table with these values.

   

   

3. Select Save in the top right.

4. Activate the new environment we created by setting the Postman Environment from No Environment to DSP in the top right.

Step 6. Test your configuration

Your Yahoo DSP API Postman collection is now ready to use.

To test your configuration, make the Get Seats Call under the Traffic APIs:

1. Select DSP API > Seats > GET Seats.

2. Click Send.

   Note

   You may have to click Send twice if you initially get an error.

3. Check the Status of your call.

4. Check the Results of your call.

   

Pre-request Script

Both the Trafficking and Reporting Collections contain a Pre-request script that runs before every API call.

The Pre-request script is code written in JavaScript following the process described in the DSP Authentication section of the documentation to generate the required access token.

Refer to the Setup & Access Guide for more information.

The Pre-request script does not need to be altered for making calls from within Postman but may need to be recreated when building out your production solution.