revokeToken

2023-11-03 06:33

POST: /amsin/api/v1/oauth/revokeToken

需要签名验签

调用此接口来撤销一个访问令牌（access token)，撤消的令牌将无法再用于授权。

说明：撤销访问令牌的同时也撤消了刷新令牌（refresh token)。

接口结构

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

请求参数

字段名

数据类型

是否必传

描述

token

字符串

是

取消访问令牌（access token) 时使用的令牌信息。

更多信息：

字段最大长度：128 characters

tokenType

字符串

是

使用的令牌类型。可取值：

ACCESS_TOKEN：令牌类型是访问令牌（access token）。

更多信息：

字段最大长度：128 characters

响应参数

字段名	数据类型	是否必填	描述
result	Result 对象	是	API的调用结果。
说明：以下字段，只有当 result.resultStatus = `S` 时才会按需返回。
cancelTime	DateTime字符串	有条件必填	撤销访问令牌的时间。更多信息：此字段采用ISO 8601 标准时间戳。如：`2018-09-03T00:00:00+08:00`，或`2019-01-01T01:01:01Z`（UTC时间）

响应处理

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

result.resultStatus	描述
`S`	API请求成功。
`F`	API请求失败。具体失败原因，参见结果码（即 result.resultCode 和 result.resultMessage）。
`U`	API响应结果为`U`（未知）时，集成商需重试API请求。重试策略：重试次数上限：7次重试时间间隔：5分钟、10分钟、20分钟、40分钟、80分钟、160分钟、320分钟如果问题依旧，请联系万里汇技术支持。

结果码

`result.resultCode`

resultCode	resultStatus	resultMessage	resultMessage 中文含义	处理建议
SUCCESS	S	Success	成功
PROCESS_FAIL	F	A general business failure occurred. Do Not retry.	请求处理失败，请勿重试	需要人工介入，联系万里汇技术支持以解决此问题
PARAM_ILLEGAL	F	Illegal parameters exist. For example, a non-numeric input, or an invalid date.	参数异常	修改订单信息、更换requestId，发起重试
INVALID_API	F	The called API is invalid or not active.	调用的接口已失效或停用	确认是否调用正确的API
INVALID_CLIENT	F	The client is invalid.	调用的用户无效	Client ID不存在或无效
INVALID_SIGNATURE	F	The signature is invalid.	签名校验失败	确认请求正确加签，更换requestId，发起重试
METHOD_NOT_SUPPORTED	F	The server does not implement the requested HTTP method.	HTTP请求方法不支持。	确认HTTP请求方法为`POST`
UNKNOWN_EXCEPTION	U	The API call is failed, which is caused by unknown reasons.	未知错误	无需更换requestId，发起重试
UN_SUPPORT_BUSINESS	F	Unsupported business.	包含无效参数	包含无效参数，使用正确参数重试
INVALID_ACCESS_TOKEN	F	The access token is invalid.	访问令牌（access token)）已失效。	请使用正确的accessToken
AUTHORIZATION_NOT_EXIST	F	The authorization does not exist.	授权不存在	当前授权关系不存在，请联系万里汇技术支持检查授权关系

代码示例

示例一：成功

请求体

copy
{
    "token": "282888130000470616850250350*****",
    "tokenType":"ACCESS_TOKEN"
}

响应体

copy
{
    "result": {
        "resultStatus": "S",
        "resultCode": "SUCCESS",
        "resultMessage": "success"
    },
    "cancelTime": "2023-05-29T06:27:25Z"
}

示例二：失败

请求体

copy
{
    "token": "282888130000470616850250350*****",
    "tokenType":"ACCESS_TOKEN"
}

响应体

copy
{
    "result": {
        "resultStatus": "F",
        "resultCode": "AUTHORIZATION_NOT_EXIST",
        "resultMessage": "The authorization not exist"
    }
}