核查中心(订单)订阅 API 是用于您在 TD 平台进行订单核查操作后,将核查结果(拒绝、通过)主动推送到您订阅的 API 地址,以便于您的业务系统接收到结果后进行进一步的操作流程,如取消订单等。
API 方式
Base URL
您在 TD 客户平台订阅中心配置的核查中心(订单)订阅 API 地址
API
URL | 请求方式 | Content-Type | 输出格式 | 字符集 |
---|---|---|---|---|
api-base-url?timestamp=xxx&partner_code=xxx&access_key=xxx&sign=xxx | POST | application/json | JSON | UTF-8 |
认证参数
字段 | 类型 | 含义 | 建议 | 备注 |
---|---|---|---|---|
timestamp | String | 当前时间戳 | 必须 | 毫秒级 |
partner_code | String | 合作方标识 | 必须 | 由 TD 分配 |
access_key | String | access key | 必须 | 由 TD 分配,可通过 TD 客户平台订阅中心查看 |
sign | String | 签名 | 必须 |
sign 生成方式
sign = HmacSHA1(partner_code+timestamp+access_key,access_secret)
其中 access_secret 由 TD 分配,可通过 TD 客户平台订阅中心查看
headers
参数名 | 参数值 | 建议 | 备注 |
---|---|---|---|
Content-Type | application/json | 必须 | |
xxx | xxx | 条件必须 | 您在TD 客户平台订阅中心配置的自定义参数 |
推送请求参数
字段 | 类型 | 含义 | 建议 | 备注 |
---|---|---|---|---|
type | String | 推送的 ID 类型 | 必须 | 枚举值:order_id |
id | String | 推送的 ID 内容 | 必须 | |
result | String | 反馈结果 | 必须 | 枚举值: decline accept |
operator | String | 操作人 | 必须 | 操作人员的名字,如果名字不存在则用操作人员的账号(邮箱等) |
time | Long | 操作时间 | 必须 | 毫秒级时间戳 |
reason | String | 原因或备注 | 建议 |
推送请求示例
{
"type": "order_id",
"id": "1648777165770866F82AC7F326307055",
"result": "accept",
"operator": "Pierre-zb",
"time": "1673402388579",
"reason": "lorem tags"
}
响应参数
您的业务系统在收到推送请求后需要响应的参数
字段 | 类型 | 含义 | 建议 | 备注 |
---|---|---|---|---|
code | Integer | API 状态码 | 必须 | |
message | String | 状态信息 | 必须 | 在 API 异常状态下会输出具体的异常原因 |
API 状态码
code | 含义 |
---|---|
200 | 成功 |
响应示例
{
"code": 200,
"message": ""
}