applyToken需要签名验签

POST /amsin/api/v1/oauth/applyToken

集成商调用此接口申请访问令牌(access token),以代表用户进行接口调用。

前提条件:集成商通过WorldFirst万里汇页面完成授权。WorldFirst随后生成授权码(authCode)。使用此授权码(authCode)来调用 applyToken 接口。

报文结构

万里汇接口的报文结构包括:请求头、请求体、响应头和响应体。该章节主要介绍请求体和响应体的结构。关于请求头和响应头的更多信息,参见:

入参

authCode String  REQUIRED

授权码。指用户通过万里汇页面完成授权后返回的码值。

例如在以下返回的URL里, code 的值就是授权码。

https://{domain}/?authResult=SUCCESS&code=*****

grantType String  REQUIRED

授权模式

可取值:

  • AUTHORIZATION_CODE: 使用授权码(authCode)来获得访问令牌(access token)。

出参

result Result object REQUIRED

代表API接口的调用结果。

Show child parameters

accessToken String  REQUIRED

访问令牌(access token)。

此字段只有当 result.resultStatusS 时才会按需返回。

expireTime DateTime  REQUIRED

访问令牌(access token)的过期时间。

此字段只有当 result.resultStatusS 时才会按需返回。

更多信息:

  • 值遵循 ISO 8601 标准格式。例如,“2019-11-27T12:01:01+08:00”。

refreshToken String  

刷新令牌(refresh token) 。

此字段只有当 result.resultStatusS 时才会按需返回。

refreshTokenExpireTime DateTime  

刷新令牌(refresh token) 的过期时间。

此字段只有当 result.resultStatusS 时才会按需返回。

更多信息:

  • 值遵循 ISO 8601 标准格式。例如,“2019-11-27T12:01:01+08:00”。

extendInfo String  

拓展字段。

此字段只有当 result.resultStatusS 时才会按需返回。

API Explorer

请求

URL
Case
Result status is S/Success
请求体

响应

Case
Result status is S/Success
响应体

响应处理

集成商调用接口后,万里汇通过 result.resultStatus 字段返回集成商 API 调用结果。此字段的取值范围如下:

result.resultStatus

描述

S

API请求成功。

F

API请求失败。具体失败原因,参见结果码(即 result.resultCoderesult.resultMessage)。

U

API响应结果为U(未知)时,集成商需重试API请求。

重试策略:

  • 重试次数上限:7次
  • 重试时间间隔:5分钟、10分钟、20分钟、40分钟、80分钟、160分钟、320分钟

如果问题依旧,请联系万里汇技术支持。

结果码

结果码结果码信息行动建议
SUCCESSSSuccess
PROCESS_FAILFA general business failure occurred. Do Not retry.

需要人工介入,联系万里汇技术支持以解决此问题

PARAM_ILLEGALFIllegal parameters exist. For example, a non-numeric input, or an invalid date.

修改订单信息、更换requestId,发起重试

INVALID_APIFThe called API is invalid or not active.

确认是否调用正确的API

INVALID_CLIENTFThe client is invalid.

Client ID不存在或无效

INVALID_SIGNATUREFThe signature is invalid.

确认请求正确加签,更换requestId,发起重试

METHOD_NOT_SUPPORTEDFThe server does not implement the requested HTTP method.

确认HTTP请求方法为POST

UNKNOWN_EXCEPTIONUThe API call is failed, which is caused by unknown reasons.

无需更换requestId,发起重试

UN_SUPPORT_BUSINESSFUnsupported business.

包含无效参数,使用正确参数重试

AUTH_CODE_EXPIREDFThe authorization code (authCode) is expired.

确认所使用的授权码(authCode是否正确。

AUTH_CODE_NOT_EXISTFThe authorization code (authCode) does not exit.

重新获取有效的授权码authCode

@2024 WorldFirst