Download the PHP package ups-api/php-widget-sdk without Composer

On this page you can find all versions of the php package ups-api/php-widget-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package php-widget-sdk

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?

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." } ] } }

All versions of php-widget-sdk with dependencies

PHP Build Version
Package Version
Requires php Version ^8.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package ups-api/php-widget-sdk contains the following files

Loading the files please wait ...