ups-api / php-widget-sdk
此SDK将帮助您使用PHP生成访问令牌。使用此访问令牌,您将能够连接到UPS支持的Widgets。
1.1.0
2023-12-19 16:16 UTC
Requires
- php: ^8.0
README
此存储库将托管SDK,这些SDK可以帮助您生成用于与UPS开发的Widgets一起使用的OAuth令牌。
常见问题解答
UPS支持哪些技术?
- UPS目前已开发了适用于.NET(6.0)和GO语言的SDK。还提供了PHP脚本的脚本。
我的团队如何使用您的SDK?
- 在分支部分找到您的支持技术。根据ReadMe中的说明进行您的特定实现。
令牌的有效期有多长?
- 成功创建的令牌有效期为四(4)小时。在令牌中有一个名为
exp
的属性,可以用来计算剩余时间。
令牌看起来像什么?
- 有效的令牌由一串随机字符的编码字符串(最多1000个字符)表示。
我如何创建令牌?
- SDK公开了
generateToken()
,可以用来获取令牌。generateToken()
需要两个字符串:clientId
和clientSecret
。其他可配置的参数包括headers
、postData
和queryParams
。
我如何获取Client Id和Client Secret?
- 在UPS开发者门户上注册。按照步骤进行上线并获取id和密钥。
响应规范
成功生成令牌
有效的成功响应将返回OAuth访问令牌。
{ "response": { "errors": [ { "code":"DTG001", "message":"Token generation has encountered an error. Please contact your UPS Relationship Manager." } ] } }
失败生成令牌
无效或错误的响应将引发异常。异常将包含包含错误代码和信息的消息。
错误
错误示例
{ "response": { "errors": [ { "code":"DTG001", "message":"Token generation has encountered an error. Please contact your UPS Relationship Manager." } ] } }