增加一些新接口的文档
This commit is contained in:
zhl
parent
08c3e422c9
commit
1d94c53773
159
doc/api.md
159
doc/api.md
@ -1,4 +1,14 @@
|
|||||||
# 答题游戏接口说明
|
# 答题游戏接口说明
|
||||||
|
|
||||||
|
## 修改记录
|
||||||
|
|
||||||
|
### 20200604
|
||||||
|
1. [增加用户信息](#212), [抽奖转盘信息](#213), [抽奖](#214), [邀请奖励信息](#215), [挑战详情](#216) 接口
|
||||||
|
2. 所有接口增加post字段 version(当前版本固定取1.0.1)和sessionid(取自jcfw)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## 一. 说明
|
## 一. 说明
|
||||||
|
|
||||||
所有接口均需上传sessionid
|
所有接口均需上传sessionid
|
||||||
@ -442,7 +452,7 @@
|
|||||||
### 11. 用户券列表
|
### 11. 用户券列表
|
||||||
|
|
||||||
1. Method: POST
|
1. Method: POST
|
||||||
2. URI: /api/:accountid/tickets
|
2. <span id="211">URI: /api/:accountid/tickets</span>
|
||||||
|
|
||||||
| 字段 | 说明 |
|
| 字段 | 说明 |
|
||||||
| -------- | -------------------------------------- |
|
| -------- | -------------------------------------- |
|
||||||
@ -458,7 +468,7 @@
|
|||||||
3. Response: JSON
|
3. Response: JSON
|
||||||
|
|
||||||
```js
|
```js
|
||||||
{
|
[{
|
||||||
id: '记录id',
|
id: '记录id',
|
||||||
shop: '店铺id',
|
shop: '店铺id',
|
||||||
shopName: '店铺名',
|
shopName: '店铺名',
|
||||||
@ -466,5 +476,150 @@
|
|||||||
couponName: '券名',
|
couponName: '券名',
|
||||||
couponUrl: '券图片url',
|
couponUrl: '券图片url',
|
||||||
status: '状态' //0: 未使用 , 1: 已使用 9: 已过期
|
status: '状态' //0: 未使用 , 1: 已使用 9: 已过期
|
||||||
|
}]
|
||||||
|
```
|
||||||
|
|
||||||
|
### 12. 用户信息
|
||||||
|
|
||||||
|
1. Method: POST
|
||||||
|
2. <span id="212">URI: /api/:accountid/info</span>
|
||||||
|
|
||||||
|
| 字段 | 说明 |
|
||||||
|
| -------- | -------------------------------------- |
|
||||||
|
| accountid | 帐号id |
|
||||||
|
|
||||||
|
> POST参数
|
||||||
|
|
||||||
|
|
||||||
|
| 字段 | 说明 |
|
||||||
|
| -------- | -------------------------------------- |
|
||||||
|
| sid | 店铺id, 不传的话获取所有 |
|
||||||
|
|
||||||
|
3. Response: JSON
|
||||||
|
|
||||||
|
```js
|
||||||
|
[{
|
||||||
|
shop: '店铺id',
|
||||||
|
tocket_lottery: 10, //用户在当前店铺拥有的抽奖券数量
|
||||||
|
}]
|
||||||
|
```
|
||||||
|
|
||||||
|
### 13. 抽奖转盘信息
|
||||||
|
|
||||||
|
1. Method: POST
|
||||||
|
2. <span id="213">URI: /api/:accountid/lottery_info</span>
|
||||||
|
|
||||||
|
| 字段 | 说明 |
|
||||||
|
| -------- | -------------------------------------- |
|
||||||
|
| accountid | 帐号id |
|
||||||
|
|
||||||
|
> POST参数
|
||||||
|
|
||||||
|
|
||||||
|
| 字段 | 说明 |
|
||||||
|
| -------- | -------------------------------------- |
|
||||||
|
| sid | 店铺id |
|
||||||
|
|
||||||
|
3. Response: JSON
|
||||||
|
|
||||||
|
```js
|
||||||
|
[{
|
||||||
|
"name": '显示名',
|
||||||
|
"reward_type": '奖励物品的id',
|
||||||
|
"reward_count": 100, //奖励物品数量
|
||||||
|
"icon": "item/item_0" // 奖励物品的图片地址, 可能是本地,远程, 如果该字段为空的话, 需要取本地的默认值
|
||||||
|
}]
|
||||||
|
```
|
||||||
|
|
||||||
|
### 14. 抽奖
|
||||||
|
|
||||||
|
1. Method: POST
|
||||||
|
2. <span id="214">URI: /api/:accountid/lottery</span>
|
||||||
|
|
||||||
|
| 字段 | 说明 |
|
||||||
|
| -------- | -------------------------------------- |
|
||||||
|
| accountid | 帐号id |
|
||||||
|
|
||||||
|
> POST参数
|
||||||
|
|
||||||
|
|
||||||
|
| 字段 | 说明 |
|
||||||
|
| -------- | -------------------------------------- |
|
||||||
|
| sid | 店铺id |
|
||||||
|
|
||||||
|
3. Response: JSON
|
||||||
|
|
||||||
|
```js
|
||||||
|
{
|
||||||
|
"name": '显示名',
|
||||||
|
"reward_type": '奖励物品的id',
|
||||||
|
"reward_count": 100, //奖励物品数量
|
||||||
|
"icon": "item/item_0" // 奖励物品的图片地址, 可能是本地,远程, 如果该字段为空的话, 需要取本地的默认值
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### 15. 邀请奖励信息
|
||||||
|
|
||||||
|
1. Method: POST
|
||||||
|
2. <span id="215">URI: /api/:accountid/share_rewards</span>
|
||||||
|
|
||||||
|
| 字段 | 说明 |
|
||||||
|
| -------- | -------------------------------------- |
|
||||||
|
| accountid | 帐号id |
|
||||||
|
|
||||||
|
> POST参数
|
||||||
|
|
||||||
|
|
||||||
|
| 字段 | 说明 |
|
||||||
|
| -------- | -------------------------------------- |
|
||||||
|
| sid | 店铺id |
|
||||||
|
|
||||||
|
3. Response: JSON
|
||||||
|
|
||||||
|
```js
|
||||||
|
[{
|
||||||
|
"name": '显示名',
|
||||||
|
"reward_type": '奖励物品的id',
|
||||||
|
"reward_count": 100, //奖励物品数量
|
||||||
|
"icon": "item/item_0" // 奖励物品的图片地址, 可能是本地,远程, 如果该字段为空的话, 需要取本地的默认值
|
||||||
|
}]
|
||||||
|
```
|
||||||
|
|
||||||
|
### 16. 挑战详情
|
||||||
|
|
||||||
|
1. Method: POST
|
||||||
|
2. <span id="216">URI: /api/:accountid/shop</span>
|
||||||
|
|
||||||
|
| 字段 | 说明 |
|
||||||
|
| -------- | -------------------------------------- |
|
||||||
|
| accountid | 帐号id |
|
||||||
|
|
||||||
|
> POST参数
|
||||||
|
|
||||||
|
|
||||||
|
| 字段 | 说明 |
|
||||||
|
| -------- | -------------------------------------- |
|
||||||
|
| sid | 店铺id |
|
||||||
|
| eid | 挑战活动id |
|
||||||
|
|
||||||
|
3. Response: JSON
|
||||||
|
|
||||||
|
```js
|
||||||
|
{
|
||||||
|
"id": "609e13eeccc78154ac683583", //id
|
||||||
|
"name": "第一期测试", // 测验
|
||||||
|
"desc": "简介",
|
||||||
|
"icon": "", // 相关icon
|
||||||
|
"banner": "", // 介绍大图
|
||||||
|
"rewards": [ // 奖励列表
|
||||||
|
{
|
||||||
|
coupon: '优惠券的id',
|
||||||
|
name: '优惠券名',
|
||||||
|
count: 1, //数量
|
||||||
|
couponUrl: '优惠券详情图的url',
|
||||||
|
type: 0, //类型 0: 单局能获得的奖励 1: 累计榜能获得的奖励
|
||||||
|
}
|
||||||
|
]
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
Loading…
x
Reference in New Issue
Block a user