Skip to content

Postman

Last Update: January 7, 2023

eAPI Postman Collections

Postman is a third-party application for making API requests. The Maxar eAPI Postman collection provides working examples for getting an authorization token, searching, and ordering imagery. These collections are a great way to learn how to use eAPI!

Steps

1. Download Postman

If you don't already have it you will need to download the Postman desktop application. View their documentation here.

2. Download the eAPI Postman collection and environment

To make API requests using the Postman client, download the zip file below. The zip contains the Postman collection and environment JSON files for eAPI.

eAPI Postman Collection and Environment Zip File

3. Unzip eapi-postman.zip

4. Import the JSON files

The zip file contains 2 JSON files:

  • eAPI.postman_collection.json
  • eAPI.postman_environment.json

In Postman, click on the "Import" button near the top the far left of the application. Import Postman JSON

A modal dialog will pop up. Choose "Folder". Next, click the "Choose folder from your computer button, and browse to the location you unzipped the files in.

Import Postman JSON

The dialog will change and illustrate which items you are about to import. Click the "Import" button.

Import Postman JSON

5. Select the Postman Environment

When you set up the Postman environment, eAPI, may be set as your default environment. You should see "eAPI" at the top right of the page. If you see "no environment" or a different environment, click the dropdown error and choose eAPI from the dropdown menu.

Import Postman JSON

6. Authorization

The eAPI collections are configured to allow users to add their eAPI credentials to the top-level folder. Adding them here will allow them to be inherited by all of the child folders, and example requests contained in them.

To set this up you will need to click on the top-level eAPI folder for the collection. From there you will be presented with a form to input your credentials.

a. Add your eAPI username, and password to the form.
b. Scroll to the bottom of the form and click on the "Get New Access Token" button

Import Postman JSON

c. A new modal will pop, and if successful you will see your token. You will need to click the "Use Token" button. This will set the token so that it can be used by all of the Postman requests.

Import Postman JSON

Note: A token is valid for 12 hours. Once a token expires, you'll need to request a new one.

7. Collections

The eAPI collections should now be present in the list near the top, on the left-hand side of the application.

There will be two folders:

  • 1B Searching
  • 1B Ordering

These folders contain example Postman requests using the eAPI endpoints. Import Postman JSON

To send a request you will need to choose a folder, and then pick a request. In the example below we are using eAPI's /search endpoint to search for imagery. We are sending two query parameters: collections, and limit. Click the "Send" button to execute the request.

This particular eAPI request is looking for the latest WorldView 2 satellite image. Browse through the various requests to see additional ways to search, and then order imagery from eAPI.

To view more details on the eAPI Search capabilities view the user guide.

To view more details on the eAPI Order capabilities view the user guide.

Import Postman JSON