一、服务器地址
二、公共请求头参数
参数名称 | 类型 | 是否必选 | 描述 |
token | String | 是 | 用户唯一标识 |
备注:为了方便我们今天演示,服务端接受所有
token
。
三、接口
1. 创建红包雨
- 请求方式:GET
- 请求地址:
/api/v1/send/{total}/{num}
参数 | 类型 | 是否必传 | 说明 |
total | Number | 是 | 本次奖池总金额 |
num | Number | 是 | 本次红包个数 |
返回示例:(data
为本场红包雨唯一表示)
{ "code": 200 "data": "c03d2a1e2ee341a68cfdc1e8a848bcf2" "message": "操作成功" }
2. 领取红包
- 请求方式:GET
- 请求地址:
/api/v2/rob/{redPackageKey}
参数 | 类型 | 是否必传 | 说明 |
redPackageKey | String | 是 | 本场红包雨唯一标识 |
返回示例:
{ "code":200, "message":"操作成功", "data":null }
3. 获取最终奖励
- 请求方式:GET
- 请求地址:
/api/v2/record/${redPackageKey}
参数 | 类型 | 是否必传 | 说明 |
redPackageKey | String | 是 | 本场红包雨唯一标识 |
返回示例:(data
为得到的最终金额)
{ "code":200, "message":"操作成功", "data":14 }
4. 准点红包雨(webSocket)
- 请求类型:WS
- 请求地址:
ws://rb.atguigu.cn/api/websocket/{activityKey}/{token}
参数 | 类型 | 是否必传 | 说明 |
activityKey | String | 是 | 活动唯一标识 |
token | String | 是 | 用户唯一标识 |
返回示例
duration
:红包雨持续时长。generationRate
:红包生成速率。redPackageKey
:本场红包雨唯一标识。
{ "activityKey":"hd_fff0d53ed457459c9813121bc75acffa", "duration":5000, "generationRate":200, "redPackageKey":"c3b01deffb484cc3a72802797ee67c0e" }