USPS - How to Get the API Key?

Signing Up for USPS Shipping APIs

In order to integrate USPS data into Delivery Defense: Visibility, we require that you sign up for a free USPS Web Tools account and obtain the required API key.

This guide will show you how to setup your account registrations with USPS and then integrate your credentials within the Delivery Defense: Visibility platform.

Note: When registering with USPS, you will initially be placed on a Test API server on their system. In order to successfully integrate USPS with Delivery Defense: Visibility, you will need to have USPS move you to a Production API server. More information on this can be found below.

Signing Up

The USPS website provides a simple registration form that you must complete to gain access to the USPS Web Tools system.

1. Go to the USPS Web Tools Registration form located here.
2. Complete all the required fields of the registration form.
3. Click the Submit button.

You will see a confirmation page thanking you for registering. You should receive a confirmation email within 24 hours.

Obtaining your API Credentials

The confirmation email you receive from USPS will contain a username and password to use. However, you will need to contact USPS for “Production Server Access” before these credentials will work.

In the confirmation email, locate and record the Username and Password.

Obtaining Product Server Access

In order for your product to be able to use the shipping rate lookup feature, you will need to request that USPS provide you with production server access.

1. Send an email to [e-mail] with the following information.

Subject: Production Server Access

Email Body: I am using Delivery Defense: Visibility to provide shipping updates through USPS. In order to use this feature, I will need live production server access instead of the testing access I have so far. My Username is {Enter Username from Confirmation Email}

It may take a couple of days to receive a response, but once USPS moves your account to their production server, your shipping rate lookup should work with the credentials you received in the confirmation email.

Adding Credentials to Delivery Defense: Visibility

1. Login to your DDVIS tenant
2. Select the Carrier Credentials App
3. Click the Setting button
4. Next to the USPS section, select "Enter Credentials"
5. Enter your USPS API credentials to the provided fields
6. Select "Save"