如要使用任何MG+ 系统,必须先进行身分验证并获得有效令牌才可取得访问权限。
访问令牌:在 STS 上呼叫 /connect/token 的方法后接收的字符串。该字符串为授权代码并由编码方式呈现。每个令牌都有其到期时间。
此服务为标准的 RESTful 服务。
STS Endpoint
您可于 MG + 后台 > 工具 > 用户管理 > 商户信息 (相关的商户旁边的 i 按钮) 查询您个人的 STS 网址。如有需要,请联系您的 MG+ 客户经理以获取其他帮助。
STS 方法
如需进行 MG+整合,需先呼叫STS API。 请提供您的代理人码和 API 密码给STS。您将收到一个JWT令牌。
POST /connect/token
Request Header
Content-Type: “application/x-www-form-urlencoded”
Request Parameters
|
请求参数 |
必要 |
资料型态 |
值 |
|---|---|---|---|
|
grant_type |
是 |
String |
“client_credentials” |
|
client_id |
是 |
String |
<Agent Code ID> 代理人码。 |
|
client_secret |
是 |
String |
<Agent Secret> API 密码由 MG+ 提供。 |
Response Data
|
回应参数 |
资料型态 |
描述 |
|---|---|---|
|
access_token |
String |
符合 RFC7519 的 JSON Web 令牌 (JWT)。 |
|
expires_in |
Integer |
过期秒数。 |
|
token_type |
String |
Token type. Constant: “Bearer”. |
错误
|
HTTP 代码 |
內容 |
描述 |
|---|---|---|
|
400 |
invalid_request |
请求格式错误。 |
|
400 |
invalid_client |
凭证错误。 |
|
400 |
unsupported_grant_type |
授权类型不支援。 |
|
500 |
general_error |
服务器错误,罕见,请重试。 |
令牌建议更新方式
每个访问令牌都有其事先定义的到期时间。
最佳实践是在收到访问令牌后对其进行存储,在其有效期间用于所有调用,并实施后台令牌刷新过程(参考前面 API 调用流程的示例)。在令牌过期的15分钟前,请利用 /connect/token 的方法来获取新令牌。
访问令牌符合 JWT,并且在解码后还将包含以下字段:
-
nbf – 令牌有效性起始時標 (UNIX)。
-
exp – 令牌失效性起始時標 (UNIX)。