Postman API Toolkit

For purposes of testing and verifying the calls you make in the Gemini API, you may wish to set up the Postman HTTP client, which lets you make requests (GET, PUT, POST, and DELETE calls) to the Gemini RESTful APIs.

Postman is a widely used tool for building and handling HTTP requests to REST-based services. It can be useful in your development efforts for optimizing, testing and error-checking your API calls when working with the programmatic Gemini API.

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

Install Postman

Begin by installing Postman from

www.getpostman.com

You can 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.

Once you download the free version of Postman, you can follow these 3 steps to complete your install:

postman install

Update Postman Global Variables

To work successfully with the Gemini API Postman collection, you will need to update your Postman environments. Global variables are used here, so you don’t have to update each call separately, but instead, you can simply update one value.

To update global variables for the Gemini API Postman collection, follow these steps:

  1. Click the gear icon in the upper right corner of Postman and select Manage Environments.
postman environments gear icon

  1. Click Add to create a new environment.
  2. Name your environment.
  3. Enter the Key/Value pairs shown in the table below in the Postman Manage Environments panel:

Key Description
Authorization Your access_token found in steps 4 and step 5 of OAuth Authentication
client_secret Your client_secret from your Gemini App
client_id Your client_id from your Gemini App
code Value from step 2 of OAuth Authentication
refresh_token Value returned from step 4 and step 5 of OAuth Authentication
basic_auth Base64 encoding of client_id:client_secret
advertiser_id Your Yahoo Gemini Advertiser ID.

Enter the values for Gemini in the Postman Manage Environments panel, shown below.

manage environments

Once you’ve completed the entry of your Key/Value pairs, click Add.

Note

The only variables you will need to update to continue testing with the Gemini API Postman collection is your authorization and refresh tokens when your access access_token and refresh_token expires.

Access the Gemini API Collection

You can get access to the Gemini API collection by simply clicking the button and selecting which version of Postman you have. After that, Postman will automatically open and ask you to import the collection.

Last Updated

  • 19 October 2017: The postman collection has been updated to the v3 endpoint for all calls in order to stay in parallel with YDN.
  • 7 August 2017: Added new Upgraded URLs (v3 Gemini API) and Bid by Site (v2) examples for the Postman collection, shown below.
postman-toolkit/images/upgraded-url-v3.png::alt:upgradedurlv3

bid site v2

  • 17 July 2017: Added bearer in front of the authorization for each call, making it easier to paste in the authorization token in the global variables. Download the latest version of the Postman collection from the same link to see this feature enabled.