Widgets-SDK

This repository will host SDKs that help you generate an OAuth Token to use with Widgets developed by UPS.

FAQ

Which technologies are supported by UPS?

• UPS currently has developed SDKs for .Net (6.0) and GO Lang. A script for PHP is also available.

How does my team use your SDK?

• Find your supported technology in the branches section. Follow the instructions in the ReadMe for your specific implementation.

How long does a token last?

• A successfully created token is valid for four(4) hours. Within the token, there is a property called exp which can be used to calculate remaining time.

What does a token look like?

• A valid token is represented by an encoded string of random characters (max 1000).

How do I create a token?

• The SDKs expose generateToken() which can be used to get a token. generateToken() requires two strings: clientId and clientSecret. Other configurable parameters include headers, postData, and queryParams.

How do I get a Client Id and a Client Secret?

• Register on the UPS Developer Portal. Follow the steps to onboard and get an id and secret.

Response Specification

Successful Token Generation

A valid and successful response will return an OAuth access token.

{ eyJhZGRyZXNzZXMiOlt7InN0cmVldCI6IjEyMzgw... }

Failed Token Generation

An invalid or erroneous response will throw an exception. The exception will contain a message with an error code and a message with information.

Errors

Error Code	Cause	Solution
DTG001	Invalid Client Id	Ensure the correct Client Id is provided as a string.
DTG002	Missing Client Id	Ensure a Client Id is provided when calling GenerateToken().
DTG003	Invalid Client Credentials	Ensure the Client Id and Secret are correct and provided as a string.
DTG008	Quota Limit Exceeded	The quota for generating tokens within the given timeframe has been exceeded. Please wait before generating more tokens.

Error Example

{ "response": { "errors": [ { "code":"DTG001", "message":"Token generation has encountered an error. Please contact your UPS Relationship Manager." } ] } }