UPS API Update: Switch to OAuth 2.0 | DeftShip Integration Guide

We want to inform you about an important update from UPS regarding their API authentication process. Starting June 3, 2024, UPS will be switching from the legacy access key model to a modern OAuth 2.0 security model. This change is designed to improve security, reduce fraud, and simplify the API usage process. In this blog post, we will guide you through what this update means, the steps you need to take, and how DeftShip is committed to ensuring a smooth transition for its users.

Starting June 3, 2024, all API transactions with UPS will require OAuth 2.0 authentication. The existing Access Key-based authorization will be deprecated, and any API calls using the old method will no longer work. This update not only improves security but also streamlines the API integration process by adopting a RESTful pattern, which allows for more flexible and dynamic API payloads.

Key Changes:

• Deprecation of Access Keys: No more access keys will be distributed after June 5, 2023. All API transactions must use OAuth 2.0 authentication.

• RESTful API Adoption: UPS APIs are now true RESTful, allowing more flexibility and easier integration.

• Bearer Token Authentication: Instead of passing credentials in the API request body, a bearer token will be used in the Authorization header.

OAuth 2.0 is a widely adopted protocol that enhances security and simplifies authorization between web applications. It uses access tokens, which are issued by an authorization server and used to authenticate and authorize API requests. This model reduces the risk of credential theft and misuse, providing a more secure environment for transactions.

1. Improved Security: Protects against unauthorized access and reduces fraud.

2. Simplified Integration: Makes it easier for third-party software providers to integrate with UPS APIs.

3. Flexible API Management: Allows dynamic updates to API payloads without strict schema maintenance.

OAuth 2.0 is a protocol used for authentication and authorization between web applications. It involves the use of access tokens, which are issued by an authorization server and used to authenticate API requests.

Bearer Tokens

A bearer token is a string of characters that represents the authorization granted to a client application. This token is included in the Authorization header of an API request. Bearer tokens have a defined lifespan, and new tokens must be requested before the current token expires.

Client Credential vs. Authorization Code Flow

• Client Credentials Flow: Used for application-to-application authentication without user interaction. Suitable for scenarios where your application transacts with UPS using a single UPS username.

• Authorization Code Flow: Used for user-to-application authentication. Suitable for scenarios where your application allows users to transact with UPS using their own UPS credentials.
  

As a DeftShip user, you benefit from seamless integration with UPS services. Here are the key points you need to know about this transition:

• Handling Technical Updates: Since we are a UPS Ready Approved Partner, DeftShip will manage all technical updates required to integrate with UPS’s OAuth 2.0 model. This means you do not need to obtain new API credentials.
  

• Providing Seamless Integration: You simply need to log in to DeftShip and authorize with our no-code integration process, and you'll be ready to go. We will implement the new OAuth 2.0 login process, ensuring you can easily authorize API transactions with your existing UPS ID and password.
  

• Ensuring Account Linkage: We will guide you through linking your UPS shipper accounts to your UPS ID to ensure continuity in API transactions.

The transition to OAuth 2.0 is a significant update that enhances the security and functionality of UPS APIs. By following the steps outlined in this guide and relying on DeftShip’s support, you can ensure a smooth migration and continued seamless integration with UPS services. Stay informed and prepared to take full advantage of the improved security and capabilities offered by OAuth 2.0.

For detailed instructions and resources, visit the UPS Developer Portal. If you need further assistance, do not hesitate to contact DeftShip support.