feat: 增加文档

prd/模板消息.md

+# 分享有礼-模板消息
+# 分享有礼-模板消息
+
+所有的模板消息通知统一使用【工单反馈结果通知】这一个模板
+
+- ### first.DATA
+
+  固定文案：{活动名称}最近动态通知
+
+- ### 处理时间
+
+  请求模板消息通知的时间
+
+- ### remark.DATA
+
+  null
+
+- ### 反馈内容
+
+  - #### **受邀人已被其他人邀请**
+
+    - **文案模板**
+
+      “您于{yyyy-mm-dd hh:mm}邀请的用户（{用户昵称}）已在此前被其他人邀请，因此无法计为您的受邀人，敬请谅解！”
+
+    - **着陆页**：活动中心
+
+  - #### **身份条件不满足**
+
+    - **文案模板**
+
+      “您于{yyyy-mm-dd hh:mm}邀请的用户（{用户昵称}）不满足本次活动的受邀人条件，因此无法计为您的受邀人，敬请谅解！详情请查看《邀请规则》或联系在线微信客服。“
+
+    - **着陆页**：邀请奖励规则
+
+  - #### **消费行为不满足**
+
+    - **文案模板**
+
+      “您的受邀人（{用户昵称}）于{yyyy-mm-dd hh:mm}产生了一笔消费（订单号：{订单流水号}），但尚未满足本次活动的消费要求，因此不作奖励结算，敬请谅解！详情请查看《消费奖励规则》或联系在线微信客服。“
+
+    - **着陆页**：邀请奖励规则
+
+  - #### **奖励限制提醒**
+
+    - **文案模板**
+
+      “您的受邀人（{用户昵称}）于{yyyy-mm-dd hh:mm}产生了一笔消费（订单号：{订单流水号}），但已超出单个受邀人的奖励上限，因此不作奖励结算，敬请谅解！详情请查看《消费奖励规则》或联系在线微信客服。“
+
+    - **着陆页**：邀请奖励规则
+
+  - #### **积分奖励提醒**
+
+    - **即时奖励**
+
+      - **延时发放**
+
+        - **文案模板**
+
+          “您的受邀人（{用户昵称}）于{yyyy-mm-dd hh:mm}完成了{行为名称}，奖励X积分将在X天后到账，以避免受邀人退款对奖励结算所造成的影响。“
+
+        - **着陆页**：积分奖励记录
+
+      - **积分冻结**
+
+        - **文案模板**
+
+          “您的受邀人（{用户昵称}）于{yyyy-mm-dd hh:mm}完成了{行为名称}，奖励X积分已到账。该笔积分在X天的冻结期内无法使用，若受邀人此后产生退款，将对奖励作重新结算，追扣（回收）相应额度的积分奖励。“
+
+        - **着陆页**：积分奖励记录
+
+      - **不予控制**
+
+        - **文案模板**
+
+          “您的受邀人（{用户昵称}）于{yyyy-mm-dd hh:mm}完成了{行为名称}，奖励X积分已到账！“
+
+        - **着陆页**：积分奖励记录
+
+    - **闯关奖励**
+
+      - **非消费类+消费类（按消费人数）**
+
+        - **文案模板**
+
+          “您已成功邀请X人{行为名称}，达成了闯关奖励要求，奖励X积分已到账！“
+
+        - **着陆页**：闯关详情
+
+      - **消费类{按消费额}**
+
+        - **文案模板**
+
+          “您邀请的好友已累计消费X元，达成了闯关奖励要求，奖励X积分已到账！“
+
+        - **着陆页**：闯关详情
+
+    - **竞赛奖励**
+
+      - **文案模板**
+
+        “您在本次活动中的{行为名称}排名第X，获得了{奖项名称}，奖励X积分已到账！“
+
+      - **着陆页**：竞赛详情
+
+    - **受邀人奖励**
+
+      - **文案模板**
+
+        “您在本次活动（{活动名称}）中完成了{行为名称}，奖励X积分已到账！“
+
+      - **着陆页**：会员中心-积分明细页
+
+  - #### **积分追扣提醒**
+
+    - **文案模板**
+
+      “您的受邀人（{用户昵称}）于{yyyy-mm-dd hh:mm}进行了一笔退款（订单号：{订单流水号}），系统将对从之前的消费奖励积分中进行追扣，额度为X。“
+
+    - **着陆页**：积分奖励记录
+
+  - #### **卡券奖励提醒**
+
+    - **闯关奖励**
+
+      - **非消费类+消费类（按消费人数）**
+
+        - **文案模板**
+
+          “您已成功邀请X人{行为名称}，达成了闯关奖励要求，奖励卡券（{卡券名称}）已到账，请前往卡券包立即领取！“
+
+        - **着陆页**：卡券包
+
+      - **消费类{按消费额}**
+
+        - **文案模板**
+  
+          “您邀请的好友已累计消费X元，达成了闯关奖励要求，奖励卡券（{卡券名称}）已到账，请前往卡券包立即领取！“
+
+        - **着陆页**：卡券包
+
+    - **竞赛奖励**
+
+      - **文案模板**
+  
+        “您在本次活动中的{行为名称}排名第X，获得了{奖项名称}，奖励卡券（{卡券名称}）已到账，请前往卡券包立即领取！“
+    
+      - **着陆页**：卡券包
+  
+    - **受邀人奖励**
+  
+      - **文案模板**
+  
+        “您在本次活动（{活动名称}）中完成了{行为名称}，奖励卡券({卡券名称})已到账，请前往卡券包立即领取！“
+    
+      - **着陆页**：卡券包
+      
+    - **认证后投放**
+    
+      - **文案模板**
+    
+        “您在本次活动（{活动名称}）中完成了会员认证，奖励卡券({卡券名称})已到账，请前往卡券包立即领取！“
+    
+      - **着陆页**：卡券包
+
+# 
\ No newline at end of file

prd/转化链路保障.md

+# 转化链路保障
+# 转化链路保障
+
+1. ### 需求概述
+
+   当管理员创建或编辑活动后，会触发该模块的运行。
+
+   所谓保障，即确保受邀人在转化链路中能照着预定的轨迹产生交互，并实现全链路的身份识别和行为监控。
+
+2. ### 提供小程序卡片投放接口（客服消息）
+
+   供服务号关注事件处理的模块调用，向受邀人发送相应的小程序卡片。
+
+   - 以下这些转化路径，将发送不同的小程序卡片：
+
+     ![mark](http://qiniu.demogic.com/blog/20191111/kBK3KkyDllut.png?imageslim)
+
+     1. 发送活动营销页的小程序卡片，不需要带入邀请人参数。
+
+     2. 发送会员认证的小程序卡片，不需要带入邀请人参数。
+
+     3. 发送游戏页面的小程序卡片，不需要带入邀请人参数。
+
+     4. 发送微信原生卡券，不需要带入邀请人参数。
+
+        
+
+3. ### 提供卡券投放接口
+
+   供会员认证事件处理的模块调用，向受邀人投放活动指定卡券。
+
+   会员认证后进行逻辑判断，若满足活动属于以下转化路径，则调用卡券投放接口，将卡券放入用户的卡券包（待领取状态），并调用受邀人卡券奖励的模板消息通知。
+
+   ![mark](http://qiniu.demogic.com/blog/20191111/XhtfrgB5oW73.png?imageslim)
+
+   
+
+   
+
+   

prd/需要配合的其他业务模块.md

+# 需要配合的其他业务模块
+# 需要配合的其他业务模块
+
+以下各个模块需要配合相关工作，以保证分享有礼项目能够正常运行。
+
+- ### **会员认证流程自动跳转**
+
+  约定参数规格，支持请求方在页面请求中带入参数，在会员认证流程结束后跳转到参数中对应的页面。
+
+  注意：需要在页面栈中将会员认证流程的页面全部杀掉，防止用户回到上一步。
+
+- #### 链接小工具
+
+  - **支持添加自定义路径链接**
+
+    目前支持自定义H5链接，但不支持自定义小程序路径（商户小程序）。在本次分享有礼的迭代中，必须支持该功能，才能保证业务正常进行。
+
+    链接小工具的链接类型中新增【自定义路径】选项，位置排在【会员功能】和【第三方小程序】之间
+
+    管理员选择该项后，有以下几项配置项
+
+    - **进入条件**
+
+      设置用户是否需要认证后才能访问，和【H5页面】的链接类型中的“进入条件”配置项逻辑一样。
+
+    - **链接名称**
+
+      不是页面的title，而是链接的名称，装修页面中有些地方需要显示该超链接的页面名称，则需要调用该字段。
+
+      和【H5页面】的链接类型中的“名称”配置项逻辑一样。
+
+    - **小程序路径**
+
+      目标小程序页面路径，和【H5页面】的链接类型中的“网址”配置项逻辑一样。
+
+      
+
+  - **支持会员认证流程自定义回调页面**
+
+    当用户选择【链接类型：会员功能-会员认证】时新增回跳页面的配置项，详见原型
+
+    - **请求页面**
+
+      即在哪个页面请求跳转的会员认证流程，认证完后就回哪个页面。
+
+    - **指定页面**
+
+      手动选择一个页面，认证完后跳转到该页面。这部分的交互以配置链接的交互一样，只是前端处理的时候需要实现页面自动转发，不需要用户点击。
+
+- #### 游戏页面的会员认证请求要加回跳参数
+
+  上面讲到，要支持用户配置会员认证链接时自定义回调页面，其实也就是在相应的请求中加参数。
+
+  但是，游戏中引导用户去会员认证的链接不是用户手动配置的，是系统设计死的，因此本次迭代中需要将所有游戏页面的会员认证请求加参数，支持会员认证结束后回到请求页面。
+
+  包括以下这些游戏：
+
+  - 大转盘
+
+  - 刮刮卡
+
+  - 拼图游戏
+
+  - 找你马
+
+  - 口令福利
+
+    
+
+- ### **事件通知**
+
+  - **服务号关注事件**
+
+    当有用户关注服务号后，发送事件通知给分享有礼，通知中至少包含以下业务参数：
+
+    - **openID：**用于确定受邀人身份，千万不要用memberid，因为memberid在后续用户的合并中可能被删除。
+    - **时间：**以yyyy-mm-dd hh:mm:ss传入用户的关注时间
+    - **二维码参数：**将二维码中的参数原封不动给分享有礼模块即可
+
+  - **页面访问事件**
+
+    当有用户访问自定义页面，发送事件通知给分享有礼，通知中至少包含以下业务参数：
+
+    - **openID：**用于确定受邀人身份，千万不要用memberid，因为memberid在后续用户的合并中可能被删除。
+    - **时间：**以yyyy-mm-dd hh:mm:ss传入用户访问的时间
+    - **页面ID：**用于确认该页面访问的事件是否需要进行分享有礼的业务判断
+    - **邀请人参数：**将请求该页面时带入的参数原封不同给分享有礼模块即可
+
+  - **会员认证事件**
+
+    当有用户完成会员认证，发送事件通知给分享有礼，通知中至少包含以下业务参数：
+
+    - **openID：**用于确定受邀人身份，千万不要用memberid，因为memberid在后续用户的合并中可能被删除。
+    - **时间：**以yyyy-mm-dd hh:mm:ss传入事件发生的事件
+
+  - ##### 游戏参与事件
+
+    当用户参与游戏成功后，发送事件通知给分享有礼，通知中至少包含以下业务参数：
+
+    - **openID**：用于确定受邀人身份，千万不要用memberid，因为memberid在后续用户的合并中可能被删除。
+
+    - **时间**：以yyyy-mm-dd hh:mm:ss传入事件发生的事件
+
+    - **游戏计划ID**：用于确认该游戏的事件是否需要进行分享有礼的业务判断
+
+    - **邀请人参数**：
+
+      将session中的参数原封不同给分享有礼模块即可
+
+      为了实现该需要，需要游戏页面在加载时把接收到的请求参数写入session，若请求参数为空，则需要清空session。
+
+      包括以下这些游戏：
+
+      - 大转盘
+      - 刮刮卡
+      - 拼图游戏
+      - 找你马
+      - 口令福利
+
+  - **卡券领取事件**
+
+    当有用户领取了卡券，发送事件通知给分享有礼，通知中至少包含以下业务参数：
+
+    - **openID：**用于确定受邀人身份，千万不要用memberid，因为memberid在后续用户的合并中可能被删除。
+    - **时间：**以yyyy-mm-dd hh:mm:ss传入事件发生的事件
+    - **卡券ID**：用于确认该卡券领取的要进行分享有礼的业务判断
+
+  - **订单事件**
+
+    当有用户有新增订单（不管订单类型，只要是订单就发通知），发送事件通知给分享有礼。
+
+    门店订单的非会员订单不用通知，商城订单只需要传支付成功的消费订单和退款成功的退款订单。
+    
+    通知中至少包含以下业务参数：
+    
+    - **openID：**用于确定受邀人身份，千万不要用memberid，因为memberid在后续用户的合并中可能被删除。
+    - **时间：**以yyyy-mm-dd hh:mm:ss传入事件发生的事件
+    - **订单编号：**订单自身流水号
+    - **原始流水号**：退货订单、退换货订单填入，收银订单为空即可
+    - **成交商品件数：**订单中商品成交件数之和（负数的话就是减）
+    - **成交金额：**订单的rprice字段值
+    - **渠道：**开发人员自己约定，能识别渠道来源是门店、达摩微商城还是微盟微商城就好
+    - **消费门店code：**订单中消费门店的code，商城订单为空
+
+  
+
+- ### 请求接口
+
+  - ##### 提供客服消息接口
+
+    提供分享有礼模块调用，给用户发送小程序卡片。
+
+  - **提供积分冻结时长参数**
+
+    支持积分变更接口中（针对积分新增场景）支持冻结时长参数，对新增的积分做冻结期的控制。
+
+  - ##### 提供积分追扣接口
+  
+    提供分享有礼模块调用，当用户出现退款时，调用该接口并带入积分明细ID（流水号），便能将原先的获取积分进行追扣。
+    
+  - **积分明细中【事由】字段的数据字典扩充**
+  
+    - **积分新增**
+  
+      新增”分享有礼“，凡是由分享有礼请求的积分新增，都是属于该来源。
+  
+    - **积分扣减**
+  
+      新增“分享有礼追扣”，凡是由分享有礼请求的积分追扣，都是属于该来源。
+