签到+补签v2.0统一接口文档说明
# 签到+补签 v2.0统一接口说明
- 目的:实现连续周期签到和补签功能
- 步骤:用户在签到页面会看到本轮签到详情,包括本轮开始时间结束时间,第x天签到情况,如果有楼前存在和本身含有相关补签卡,就有补签历史按键。下方会有一个今日签到按钮,和漏签补签功能。用户具体签到或补签,会发放对应的积分奖励。
------
2021.5.27 补签获取面板和获取补签卡接口编号5和6 前端逻辑实现
补签面板(接口编号5):
tip1:如果返回结果的data.curRoundStatus不为1说明当前角色要么不支持参加,要么没开始本轮签到,要么已结束。应当提示用户去签到,因为本轮签到时间周期开始和结束时间不能被确定,没有返回参数的意义。
tip2:data.curRoundStatus==1的时候,说明本轮签到已开始,在进行中,拿到data.details中遍历展示每个活动的情况
获取补签(接口编号6):前端主动去调用(已幂等校验 安全)
成功分享后主动调用接口6:如http://10.60.1.226/abc/cReissue/add?type=0&getSource=0
成功发布完笔记后台主动调用接口6:如http://10.60.1.226/abc/cReissue/add?type=0&getSource=1
------
服务器地址:
测试机:10.60.1.150:8081
启按本地 :10.60.1.226
测试账号:另外提供
-------
-------
表A-统一接口说明
| 编号 | 作用 | 老接口 | 新接口 | 方式 | 传参 | 反参 |
| :--: | :-----------: | :------------------: | :--------------------------: | :--: | :---------------------: | ----- |
| 1 | 获取本轮签到详情 | 无 | cSignIn/curRoundInfo| GET | type={type} 必传 int签到类型 | 看表C |
| 2 | 签到/补签新增 | 无 | cSignIn/add | POST | type={type}&dayOffset={dayOffset} 两个都为必传 都是int type类型dayOffset今天位置偏移量 | 0失败1成功 |
| 3 | 获取本轮签到奖励列表 | 无 | cSignIn/curRoundReward | GET | 无 | 返回结果是map |
| 4 | 获取签到积分明细 | 无 | cSignIn/signInIntegralDetails | GET | 无 | 返回结果是List<CSignInIntegralDetailsVO> 看表E|
| 5 | 补签卡获取面板 | 无 | cReissue/getReissuePanel| GET | type={type} 必传 int签到类型 | 返回结果是CReissuePanelVO 看表F|
| 6 | 获取补签卡 | 无 | cReissue/add| POST | type={type}&getSource={getSource}必传 int签到类型 getSource来源(2分享3发布笔记) | 返回结果0失败1成功|
表B-传参说明(无)
------
表C-反参说明
| 编号 | 说明 | 举例 |
| :--: | --------------------------------------------------------- | ------------------------------------------------------------ |
| 1 | res.data 是 CSignInCurRoundInfoVO 对象| 看表D|
------
表D-CSignInCurRoundInfoVO (移动端本轮签到详情vo)对象属性
|字段|意义|举例|
|-|-|-|
|customerId|用户唯一id标识|90572|
|type|签到类型 |0日常|
|cycleDays|周期天数|一般都是7|
|startTime|开始时间|"2021-05-12 14:54:23"|
|endTime|结束时间|"2021-05-19 14:54:22"|
|curTime|当前时间|"2021-05-18 14:54:22"|
|curRoundInfo|本轮签到明细|[1,-1,-1,1,0,0,0]| -1补签 0未签 1已签
|todayOffset|今日位置(于开始时间偏移量)|范围0~6|
|roundNo|本轮编号|暂无可用之处|
|todayFlag|今日是否签到了|0否1是|
|continuousMax|最大连续签到次数|0~7之间|
|curRoundStatus|本轮签到状态|-1当前角色不支持 0未开始 1进行中 2已结束|
|integral|积分|int型|
|reissueCount|补签卡数量|int型|
表E-CSignInIntegralDetailsVO(移动端签到奖励明细)对象属性
|字段|意义|举例|
|-|-|-|
|index|序号||
|type|类型|0积分 1优惠券|
|content|内容|-|
|content|创建时间|-|
表F-CReissuePanelVO(移动端补签面板)对象属性 (部分字段意义参考CSignInCurRoundInfoVO 表D 一致性)
|字段|意义|举例|
|-|-|-|
|customerId|用户唯一id标识|90572|
|type|签到类型 |0日常|
|startTime|开始时间|"2021-05-12 14:54:23"|
|endTime|结束时间|"2021-05-19 14:54:22"|
|curTime|当前时间|"2021-05-18 14:54:22"|
|curRoundStatus|本轮签到状态|-1当前角色不支持 0未开始 1进行中 2已结束|
|details|名字集合|List<CReissuePanelDetailVO> 每个明细属性查看表G|
表G-CReissuePanelDetailVO(移动端补签面板明细)对象属性
|字段|意义|举例|
|-|-|-|
|type|签到类型 |0分享 1发布 2下单|
|curRoundGet|签到类型 |本轮已获取次数|
|curRoundMax|签到类型 |本轮已最大可获取次数|
|state|签到类型 |0禁止 1可用|