From 1d94c5377316057777f9765078e40fadde37d9d6 Mon Sep 17 00:00:00 2001 From: zhl Date: Thu, 3 Jun 2021 15:28:43 +0800 Subject: [PATCH] =?UTF-8?q?=E5=A2=9E=E5=8A=A0=E4=B8=80=E4=BA=9B=E6=96=B0?= =?UTF-8?q?=E6=8E=A5=E5=8F=A3=E7=9A=84=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- doc/api.md | 159 ++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 157 insertions(+), 2 deletions(-) diff --git a/doc/api.md b/doc/api.md index 5f996f1..58f9300 100644 --- a/doc/api.md +++ b/doc/api.md @@ -1,4 +1,14 @@ # 答题游戏接口说明 + +## 修改记录 + +### 20200604 +1. [增加用户信息](#212), [抽奖转盘信息](#213), [抽奖](#214), [邀请奖励信息](#215), [挑战详情](#216) 接口 +2. 所有接口增加post字段 version(当前版本固定取1.0.1)和sessionid(取自jcfw) + + + + ## 一. 说明 所有接口均需上传sessionid @@ -442,7 +452,7 @@ ### 11. 用户券列表 1. Method: POST -2. URI: /api/:accountid/tickets +2. URI: /api/:accountid/tickets | 字段 | 说明 | | -------- | -------------------------------------- | @@ -458,7 +468,7 @@ 3. Response: JSON ```js -{ +[{ id: '记录id', shop: '店铺id', shopName: '店铺名', @@ -466,5 +476,150 @@ couponName: '券名', couponUrl: '券图片url', status: '状态' //0: 未使用 , 1: 已使用 9: 已过期 +}] +``` + +### 12. 用户信息 + +1. Method: POST +2. URI: /api/:accountid/info + +| 字段 | 说明 | +| -------- | -------------------------------------- | +| accountid | 帐号id | + +> POST参数 + + +| 字段 | 说明 | +| -------- | -------------------------------------- | +| sid | 店铺id, 不传的话获取所有 | + +3. Response: JSON + +```js +[{ + shop: '店铺id', + tocket_lottery: 10, //用户在当前店铺拥有的抽奖券数量 +}] +``` + +### 13. 抽奖转盘信息 + +1. Method: POST +2. URI: /api/:accountid/lottery_info + +| 字段 | 说明 | +| -------- | -------------------------------------- | +| 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. URI: /api/:accountid/lottery + +| 字段 | 说明 | +| -------- | -------------------------------------- | +| 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. URI: /api/:accountid/share_rewards + +| 字段 | 说明 | +| -------- | -------------------------------------- | +| 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. URI: /api/:accountid/shop + +| 字段 | 说明 | +| -------- | -------------------------------------- | +| 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: 累计榜能获得的奖励 + } + ] } ``` \ No newline at end of file