异步通知
使用说明
1、触发通知条件后，友朋主动调用接口通知
2、需要在运营商后台>营销中心>开放平台>开发者中配置回调地址和勾选相应的异步通知接口
3、如果多个开发者都配置了地址，则所有的地址都会收到接口通知
4、回调地址即通知的接口地址， 根据 method 不同做不同的业务处理
5、所有接口统一采用 https post 方式调用
0x01 接口请求地址
自行配置
0x02 请求方式
Method: POST
Content-Type: application/x-www-form-urlencoded
0x03 公共请求参数
| 参数名称 | 类型 | 是否必须 | 描述 | 示例值 |
|---|---|---|---|---|
| appid | string | Y | 运营商后台创建的 AppID | 930859529955 |
| method | string | Y | 接口名称 (字母小写) | eg: notify.activity.voucher.exchangecode |
| biz_content | string | Y | 业务参数 json 字符串 | |
| timestamp | int | Y | unix 时间戳到秒 | 1556943285 |
| sign_type | string | Y | 签名方式,md5 (小写) | md5 |
| sign | string | Y | 签名(小写) | 签名方式见下文 |
0x04 返回结果结构
| 参数名称 | 类型 | 是否必须 | 说明 | 示例值 |
|---|---|---|---|---|
| error_code | int | 是 | 错误代码 =0 正常(操作成功,接口调用成功) !=0 异常错误 | 0 |
| error_msg | string | 是 | 错误描述 | ERR_SYSTEM |
| data | object | 是 | 返回业务内容 | {} |
0x05 签名
- 除 sign 参数外所有参数必须参与签名,参数以文本方式字典排序,排序后使用 key=value&key=value 方式拼接字符串
- 得到字符串 tmpString
- 签名:md5(tmpString+"&"+appSecret) 得出的结果转换为小写字母
- appSecret 在运营商后台获得
0x06 返回
统一返回 { error_code:0 , error_msg:"SUCCESS"} 即可
接口列表
| 接口(method) | 描述 |
|---|---|
| notify.activity.voucher.exchangecode | 当兑换码兑换成功并已出货的情况下触发 |
| notify.consumer.order.simple | 当售货机有交易的时候触发 |
| notify.terminal.cargo.supplement | 当售货机补货的时候触发 |
| notify.depot.pickup.return | 当补货员向仓库发起退货时触发 |
| notify.depot.changed | 当仓库库存发生变化时触发 |
| notify.cabinet.changed | 自取柜配置发生变化时触发 |
| notify.close.door | 当自取柜开门成功后时触发 |
| notify.cabinet.order.simple | 当自取柜支付成功的时候触发 |
| notify.cabinet.order.change | 当自取柜支付或退款成功时候触发 |
| notify.cabinet.alert | 当自取柜报警时触发 |