兑换结果通知接口
API文档
请求参数(POST/GET请求方式传参)
参数名 | 类型 | 是否必须 | 示例值 | 描述 |
---|---|---|---|---|
uid | string | 是 | 4839203890302 | 用户唯一性标识,对应唯一一个用户且不可变 |
app_key | string | 是 | 18888888888 | 接口app_key ,会员账号 |
timestamp | long | 是 | 1557037740232 | 时间戳,13位毫秒数 |
sign | string | 是 | app_key=x&app_secret= x&credits=x×tamp= x&uid=x |
签名(带上app_secret ,值非空的参数名按照 ASCII 码从小到大排序拼接参数名参数值后 MD5 编码) |
exchange_status | boolean | 是 | true | 兑换是否成功(true 为兑换成功,false 为兑换失败) |
message | string | 是 | 兑换成功 | 兑换详情(请用 UTF-8 进行解码) |
order_no | string | 是 | J100011908271035 | 橙券订单号 |
user_order_no | string | 否 | 13858334320712 | 开发者订单号 |
exchange_info | string | 否 | {\"biz_type\":\"积分兑换\",\"exchange_type\":\"卡券\",\"exchange_name\":\"美团外卖10元券\"} | 兑换说明信息,JSON 数据转义后的字符串 |
注:开发者收到通知后,请以橙券积分商城订单号 order_no 为准进行处理,不要以开发者订单号 user_order_no 进行处理。
响应参数
参数名 | 类型 | 是否必须 | 示例值 | 描述 |
---|---|---|---|---|
code | int | 是 | 200 | 状态码(200 为成功,其他均为失败) |
message | string | 是 | 请求通过 | 状态码描述 |
data | json | 是 | { "credits": 100 } |
返回数据 |
data 说明
参数名 | 类型 | 是否必须 | 示例值 | 描述 |
---|---|---|---|---|
credits | int | 是 | 100 | 用户积分余额 |
响应示例
{
"code": 200,
"message": "请求通过",
"data": {
"credits": 100
}
}
exchange_info 参数说明
exchange_info
参数用于标记用户积分兑换的项目类型及项目信息,参数值为将JSON
数据转义后的字符串,开发者可根据自身需要酌情解析此参数。
注意:随积分商城后续发展需要,exchange_info 内相关参数及参数值可能随时进行修改,请开发者务必做好相关处理。
参数示例:{\"biz_type\":\"积分兑换\",\"exchange_type\":\"卡券\",\"exchange_name\":\"美团外卖10元券\"}
去转义后的JSON
数据示例:
// 积分兑换示例
{
"biz_type": "积分兑换",
"exchange_type": "卡券",
"exchange_name": "美团外卖10元券"
}
// 营销活动示例
{
"biz_type": "营销活动",
"exchange_type": "答题赢大奖",
"exchange_name": "美团外卖10元券"
}
biz_type
参数用于标记用户兑换的业务类型,相关参数如下:
- 积分兑换
- 营销活动
其中 积分兑换 代表用户使用积分兑换卡券类、实物类、充值类等商品,营销活动 代表用户参与商户创建的相关营销活动。
exchange_type
参数用于标记积分兑换的商品类别或营销活动的名称。当 biz_type
为 积分兑换 时,相关参数值如下:
- 卡券
- 实物
- 充值
当 biz_type
为 营销活动 时,exchange_type
参数为商户创建的营销活动的名称。
exchange_name
参数用于标记积分兑换的商品名称或者参与营销活动获得的商品名称。