How to Create USPS API Credentials

How to Create USPS API Credentials

Overview

This article walks you through the steps for creating USPS API credentials using the USPS Developer Portal↗. These credentials allow your your Spirit Sale stores to securely access USPS APIs for services such live shipping rates.

Steps to Create API Credentials

1. Onboard via the Customer Onboarding Portal (COP)

  2. Click Customer Onboarding Portal (COP).

  3. Log in with your USPS Business Customer Gateway account or click Create New Account to register.

  4. Complete the profile with your email, company address, and contact information.

  5. If required, add your Enterprise Payment Account.


2. Log into the USPS Developer Portal

  2. Sign in using your USPS Business Account credentials.

  3. You’ll land on the Developer Portal Dashboard.


3. Create an App

  1. In the left-hand menu, click Apps.

  2. Select Add App.

  3. Complete the form:

    • App Name (required)

    • Callback URL (leave blank)

    • Description (optional)

    • Select one or more of the available API Products 

  4. Click Add App.


4. Retrieve Your API Credentials

  • After creating your app, open the Credentials tab.

  • Copy your Consumer Key and Consumer Secret.

  • Store them securely.


4. Save Your USPS API Credentials to Spirit Sale

  • Login to your Spirt Sale account.

  • From the Dashboard go to Setting --> Shipping Setup --> Select USPS under

  • Store them securely (for example, in environment variables or a secrets manager).

  • Enter your Consumer Key into the USPS Consumer Key field then the Secret into the Consumer Secret field. 

  • Press the Green Up button.

Alert
Users should not toggle on "USE USPS LEGACY SERVER" unless your USPS API credentials were created under the USPS Legacy Developer portal at developer.usps.com, and not at developers.usps.com. 


  • If your USPS credentials are successful accepted, you see the follow message in the bottom right-hand of the screen.  If not, verify that your Consumer and Secret keys are correctly entered.



Helpful Tips

  • Your default app subscription typically includes base API and with a quota of ~60 calls/hour. Contact USPS API Support to increase this. 

  • Support: For issues, use the “Email Us” form in the Developer Portal or contact USPS API support at apisupport@usps.gov.


    • Related Articles

    • Updating Your USPS Credentials in Spirit Sale (Migration to New USPS APIs)

      Who Does This Apply To This information only applies to Spirit Sale stores still using the older USPS Web Tools (Legacy) API for live shipping rates. You do NOT need to follow this guide if: You don't use USPS for shipping. You already migrated to ...

    • USPS Shipping Rates Not Showing or Intermittent at Checkout

      If USPS shipping rates are not appearing at checkout, appear inconsistent, or occasionally fail to load, this is typically related to how the United States Postal Service (USPS) API handles request limits. Why This Happens USPS provides real-time ...

    • Updating UPS Credentials to OAuth 2.0 in Spirit Sale

      Who This Applies To This update only applies to stores currently using legacy UPS credentials (Access Key authentication). If your store is already using UPS OAuth credentials (Client ID and Client Secret), no action is required. Important Notice UPS ...

    • How to Get UPS API Credentials for Spirit Sale

      Overview To use UPS shipping rates in Spirit Sale, you must create API credentials through UPS. You will generate: UPS Client ID UPS Client Secret These credentials are required to connect your UPS account and display shipping rates at checkout. ...

    • How to Set Up Your Stripe API Keys With Spirit Sale

      Overview Spirit Sale integrates directly with Stripe to process payments. To connect your store, you’ll need your live publishable key and live secret key from Stripe. Important Notes: Only standard live keys are supported. Restricted keys will not ...