About using your API credentials with Postman

You can use the Postman app to send API requests to Shipium's APIs.

You must pass your API key as a Base64-encoded value. To make things easier, we recommend that you create an environment in Postman. This document explains how to do that, and how to make a call to the ping API.

Prerequisites

• You must already have created an API key. You can find instructions for doing so in Create API Credentials.
• You must have installed Postman.

Set up an environment file in Postman

👉

What is an environment in Postman?

An environment is a set of variables you can use in your Postman requests.
For more information, see Managing Environments in the Postman user guide.

To create a new environment in the Postman application:

1. Select Environments on the left, and then the + plus button.
2. Enter a name for your environment (e.g., Shipium).
3. Create variables for API_KEY, RESOURCE_SERVER, and BASIC_AUTH_TOKEN. For more information on locating your apiKey, basicAuthToken, apiKeyId and RESOURCE_SERVER, see Create API Credentials.
4. Click Save.

📘

Postman data entry requirement

Postman requires you to enter initial and current values for the variables file. By default, Postman will automatically copy the initial value into the current value field.

Use Postman to make a call to the ping API

1. Select the + plus button (near the top of Postman) to open a new tab.
2. Enter {{RESOURCE_SERVER}}/api/v1/deliveryexperience/ping for the request URL.
3. Click the Authorization tab, and select OAuth 2.0 from the Type dropdown list.
4. From the Access Token dropdown list, select Available tokens.
5. In the field below Available tokens, enter {{BASIC_AUTH_TOKEN}}.
6. Under Header Prefix, enter Basic.
7. From the Environment dropdown list (located near the top right of Postman), select the environment you created (e.g., Shipium).
8. Click Send.

The ping API should respond with JavaScript Object Notation (JSON) that resembles this in Postman:

{ "info": "pong", "status": 1 }

👍

Use this pattern for all API calls

The example above for ping applies to all API key access of Shipium APIs.

📘

More information on the API responses

As with all Shipium API responses, this API follows the API Response Codes standards unless otherwise specified.

Resources

Your Shipium team member is available to help along the way. However, you might find these resources helpful:

• Terms and Definitions

• Troubleshooting Guide

• Contact Shipium Support