消息接口
2024年12月25日大约 2 分钟
【自建商城】可以请求【全渠道】的消息接口来通知全渠道:相关数据发生了变动。全渠道接收到消息后会根据消息类型请求自建商城相关API获取最新数据。
消息接口通过验证签名的方式来防止恶意的数据篡改,具体的签名计算方式请参考签名规则。
消息与API的区别
| 不同点 | API | 消息 |
|---|---|---|
| 请求方向 | 全渠道请求自建商城接口 | 自建商城请求全渠道接口 |
| 流程 | 全渠道 --API--> 自建商城 | 自建商城 --消息--> 全渠道 --API--> 自建商城 |
| 请求地址 | 自行配置,详见准备工作 | 固定,详见请求地址 |
| 系统参数 | API系统参数 | 消息系统参数 |
| 业务参数 | API业务参数 | 无 |
| 响应参数 | API响应参数 | 消息响应参数 |
请求地址
测试
http://117.176.129.243:60030/SelfMessage正式
https://msg.gjpqqd.cn/SelfMessage请求说明
- 请求方式为
POST - 请求头:
Content-Type=application/json;charset=utf-8
参数说明
系统参数
请求所有接口均携带的参数,以 JSON 格式放在body里,用于系统身份认证和数据安全校验。系统参数包括:
| 参数名 | 类型 | 参数描述 |
|---|---|---|
| appkey | string | 新建自建商城类型的网店后,全渠道分配的appkey,详见准备工作 |
| method | string | 发送的消息类型,详见消息类型 |
| orderid | string | 状态发生变动的订单ID(全渠道中存在的) |
| timestamp | string | 时间戳(格式:2024-01-01 12:00:00) |
| sign | string | 签名,32位长度的字符串,生成规则详见签名规则 |
{
"appkey": "A1B2C3D4E5F6G7H8I9J0K1L2M3N4O5P6",
"method": "ORDERSTATUS_UPDATE",
"orderid": "124124124124",
"timestamp": "2024-10-29 10:48:00",
"sign": "E3B0C44298FC1C149AFBF4C8996FB924"
}消息类型
系统参数中method的有效值
| 消息类型 | 说明 | 触发接口 | 适用场景 |
|---|---|---|---|
| ORDERSTATUS_UPDATE | 单据状态改变 | 获取订单详情 | 订单状态变更,包括:付款,订单取消,地址变更,备注变更,整单发货,交易成功,退款申请,退款取消,退款成功。 |
响应参数
消息接口响应为 JSON 格式。
成功格式
{
"code": "0",
"message": "success",
"success": true
}失败格式
{
"code": "-1",
"message": "签名错误",
"success": false
}