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 you create an environment in Postman. In this section, we explain how to do that, and how to make a call to the ping API.

Prerequisites

• You must already have created an API key. See Creating API Credentials.
• You must have installed Postman.

Setting 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 select the + plus button.
2. Enter a name for your environment. For example, "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 Creating API Credentials
4. Click Save.

📘

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.

Using Postman to make a call to the ping API

1. Select the + 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 from the Type dropdown list, select "OAuth 2.0".
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. For example, "Shipium".
8. Click Send.

The ping API should respond with 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.