Getting Started with UPS APIs
Learn how to integrate our suite of API functionalities into your systems with this step-by-step guide through the process of making UPS a part of your solution.
API products and their documentation can found in our API Catalog.
Create an Application
All API requests must be subscribed to an application and linked to a six-digit UPS account. You will be prompted to link your existing UPS account or create a new one during application creation. During this process, you will select the API products you want to integrate.
If you are with an organization, you may want your lead developer to have a UPS user ID as well, which can then be linked to your UPS account as a validated user.
Authenticate Your Credentials
We use OAuth 2.0 to validate your credentials and secure operations of our systems. All API calls require access tokens to authenticate users. You will use your Client ID and Secret to generate your OAuth token which can be used as your credentials for each API transaction for the life of the token. Visit our Authorization (OAuth) Product page to see UPS approved authorization flows for details on token usage.
The OAuth (open authentication) protocol enables an application to access resources controlled by someone else. This kind of access requires a token, which represents a delegated right of access without the need to impersonate the user who controls the resource.
Test It Out
We provide access to a sandbox test environment for all of our APIs allowing you to simulate request and response messaging to ensure your RESTful API requests are properly formatted. Once authorized and ready to try out your API integration, you will need to:
1. Find the API in our catalog.
2. Include your OAuth token in your request as an Authentication header.
If you do not already have an OAuth token, you will need to request one using your consumer ID and secret located in your application details.
3. Include your token as a "Bearer" token in the "Authorization" header.
Ex: Authorization: Bearer
Move To Production
Once you are satisfied with your integration, you are good to move into production. UPS does not require any additional certification to enable your implementation in the production environment. However, we do suggest retesting in the production environment with sample data before finalization.