WorldFirst DocsWorldFirst DocsDOCS

revokeToken需要签名验签

POST /amsin/api/v1/oauth/revokeToken

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

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

报文结构

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

入参

token String  REQUIRED

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

更多信息：

  • 最大长度：128 字符

tokenType String  REQUIRED

使用的令牌类型。

可取值：

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

更多信息：

  • 最大长度：128 字符

出参

result Result  REQUIRED

代表API接口的调用结果。

Show child parameters

cancelTime DateTime  CONDITIONAL

撤销访问令牌的时间。

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

更多信息：

  • 值遵循 ISO 8601 标准格式。例如，“2019-11-27T12:01:01+08:00”。
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.resultCode 和 result.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.

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

INVALID_ACCESS_TOKENFThe access token is invalid.

请使用正确的accessToken

AUTHORIZATION_NOT_EXISTFThe authorization does not exist.

当前授权关系不存在，请联系万里汇技术支持检查授权关系

@2024 WorldFirst