Skip to main content

The UPS OAuth Authorization Code API helps integrate UPS services into your business application for providing the service your application grants your customers.

Project description

Ups0authCode Python SDK 1.0.0

Welcome to the Ups0authCode SDK documentation. This guide will help you get started with integrating and using the Ups0authCode SDK in your project.

Versions

  • API version: 1.0
  • SDK version: 1.0.0

About the API

The UPS OAuth Authorization Code API helps integrate UPS services into your business application for providing the service your application grants your customers. For example, you can create UPS shipping labels with shipping rates for merchants from within your application. Since your application will not have access to your customer's UPS login credentials, the OAuth authorization code flow is used to let your customer use their UPS credentials, within your application, in a simple and secure way. Key Business Values: - Enhanced Transaction Security: The OAuth Authorization Code flow is more secure and reliable since the access token and the refresh token are never exposed in the browser's URL, thus reducing the risk of leakage or theft. - Operational Efficiency: With the ability to obtain a refresh token when the token expires, your application can maintain a long-term and uninterrupted access to the protected resources, without requiring the user to re-authenticate or re-login. Overview of steps in OAuth Authorization Code flow: (1) When user selects Login, the client application redirects to the authorization server's /authorize endpoint. (2) The Authorization Server authenticates the user by asking for their login credentials, and after successful login, the authorization server responds back to the application with an authorization code contained within a redirection URI. (3) The application then sends the authorization code and the redirection URI to the authorization server's /oauth/token endpoint. (4) The authorization server's /token endpoint verifies the authorization code and the application's client ID contained in the redirect URI, and responds with a with an access token, as well as a refresh token. (5) The Client application uses the access token to request information from an UPS API. https://developer.ups.com/api/reference/oauth/authorization-code

Table of Contents

Setup & Configuration

Supported Language Versions

This SDK is compatible with the following versions: Python >= 3.7

Installation

To get started with the SDK, we recommend installing using pip:

pip install ups-0auth-auth-code

Authentication

Basic Authentication

The Ups0authCode API uses Basic Authentication.

You need to provide your username and password when initializing the SDK.

Setting the Username and Password

When you initialize the SDK, you can set the username and password as follows:

Ups0authCode(
    username="YOUR_USERNAME",
    password="YOUR_PASSWORD"
)

If you need to set or update the username and password after initializing the SDK, you can use:

sdk.set_basic_auth("YOUR_USERNAME", "YOUR_PASSWORD")

Services

The SDK provides various services to interact with the API.

Below is a list of all available services with links to their detailed documentation:
Name
AuthorizeService
TokenService
RefreshService

Models

The SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently.

Below is a list of all available models with links to their detailed documentation:
Name Description
GenerateTokenRequest
GenerateTokenSuccessResponse
RefreshTokenRequest
RefreshTokenSuccessResponse

License

This SDK is licensed under the MIT License.

See the LICENSE file for more details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ups-0auth-auth-code-1.0.0.tar.gz (18.6 kB view details)

Uploaded Source

Built Distribution

ups_0auth_auth_code-1.0.0-py3-none-any.whl (32.7 kB view details)

Uploaded Python 3

File details

Details for the file ups-0auth-auth-code-1.0.0.tar.gz.

File metadata

  • Download URL: ups-0auth-auth-code-1.0.0.tar.gz
  • Upload date:
  • Size: 18.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.17

File hashes

Hashes for ups-0auth-auth-code-1.0.0.tar.gz
Algorithm Hash digest
SHA256 cb6c002d09a838097599a7987bef93cedc9e116001808e36805164ce78c34313
MD5 f229edc5485dee9782f74b936500c397
BLAKE2b-256 6ca8389f08399e2538b732e3b69e5b80c5c7de0cdb0420eef6f46e91d8401a40

See more details on using hashes here.

File details

Details for the file ups_0auth_auth_code-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for ups_0auth_auth_code-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 72812581edd558c4665c8e5ef1a1565f7c854c979f953a3d773aa497b631477b
MD5 051c54da247a97fd1a7b9ace29febe23
BLAKE2b-256 022ce081cebab954c163eb21b8e4e86714b5cf9903ffd3fe0894292f8dbf2b5d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page