会员插件功能介绍与使用教程

功能体验

目录

• 插件定位

• 安装与入口

• 后台和用户中心页面

• 1. 会员运营概览看板

• 2. 会员账户与权益账户

• 3. 会员等级、权益与等级记录

• 4. 充值、支付与卡密

• 5. 邀请推荐增长闭环

• 6. 签到、补签与前台小组件

• 7. 内容收藏能力

• 8. 交易流水与产品插件积分兑换

• 9. 设置、定时任务与通知

• 主题对接速查

• 运营建议

插件定位

会员插件为 Halo 站点提供一套会员运营能力：会员档案、会员等级、积分、可选储值账户、等级购买/续费记录、充值卡密、推荐码、推荐记录、签到记录、收藏记录、交易流水、前台签到和收藏小组件，以及与产品插件的积分兑换订单对接。

有些话得先说在前头，不然文档写得再漂亮也容易把业务带沟里：

• 积分 是站内权益分，用于签到、邀请、活动奖励、积分兑换商品或权益。

• 储值账户 是具备相应资质时才建议启用的储值或预付账户能力，涉及充值、提现、划转时要自己确认合规边界。

• 余额展示名称 只改变前后台文案，比如“银两”“猫猫币”，不改变账户业务性质。

• 默认合规路径建议使用积分直接兑换商品或权益，不要把积分描述成可提现或现金等价物。

安装与入口

插件声明信息来自 src/main/resources/plugin.yaml：

启用后有两个主要入口：

• 后台：控制台 > 会员管理

• 用户中心：用户中心 > 会员管理

插件设置入口在 Halo 插件详情页的设置表单中，包含通用设置、邀请设置、签到设置、收藏设置和支付设置。

后台和用户中心页面

后台「会员管理」包含：

用户中心「会员管理」包含：

1. 会员运营概览看板

功能介绍

概览页用于快速观察站点会员运营情况。后台会聚合会员总数、本期新增会员、成功交易金额、推荐注册数等指标，并提供会员增长趋势、交易金额趋势、等级分布和运营摘要。

使用教程

1. 进入 控制台 > 会员管理 > 概览。

2. 使用日期范围筛选近期运营周期，比如本周、本月或自定义时间段。

3. 查看顶部 KPI：

   • 会员总数用于判断会员规模。

   • 本期新增用于判断拉新效果。

   • 成功交易金额用于判断付费转化。

   • 推荐注册数用于判断邀请链路是否有效。

4. 查看趋势图，判断新增和交易是否随活动节点波动。

5. 查看等级分布，确认是否需要调整等级价格、权益或推荐奖励。

运营建议

• 活动前后重点看新增会员和推荐注册，别只盯交易金额。

• 等级分布长期集中在低等级时，优先检查等级价格、权益描述和升级入口。

• 推荐注册数高但交易低，说明拉新来了，转化没跟上，别一上来就怪邀请码。

2. 会员账户与权益账户

功能介绍

会员账户由 MemberInfo 承载，核心字段包括用户名、积分、储值账户额度、会员等级、等级到期时间、推荐人数、状态、注册时间和最后登录时间。

后台可维护会员档案，支持：

• 新增、编辑、删除会员信息。

• 手动增加积分。

• 在储值账户启用后手动增加储值账户额度。

• 批量设置会员等级。

• 下载模板并通过 Excel/CSV 导入设置等级。

• 一键同步有效等级记录，为未设置等级的会员补齐当前等级。

使用教程：启用或关闭储值账户能力

1. 进入插件设置。

2. 打开 通用设置 > 储值账户设置。

3. 按站点资质决定是否启用 启用储值账户能力。

4. 如果启用，可继续配置：

   • 储值账户展示名称。

   • 储值账户充值。

   • 储值账户卡密。

5. 保存设置。

使用教程：管理会员信息

1. 进入 控制台 > 会员管理 > 会员信息。

2. 使用用户名、会员等级、状态、等级有效期等筛选条件定位会员。

3. 点击新增或编辑，维护会员积分、等级和状态。

4. 如果需要批量运营，勾选会员后使用批量设置等级。

5. 如果会员量较大，下载导入模板，填写用户和等级信息后上传解析，确认无误再导入。

注意事项

• 积分默认是站内权益分，不等同储值账户额度。

• 储值账户相关操作只有在储值账户能力启用后才应开放。

• 冻结状态可用于限制会员权益使用，具体限制取决于业务调用侧如何校验会员状态。

3. 会员等级、权益与等级记录

功能介绍

会员等级由 MemberLevel 承载，主要包含等级 ID、名称、图标、描述、绑定角色、价格、有效期、状态、排序和权益配置。

等级权益包含：

等级记录由 MemberLevelRecord 承载，记录用户购买、续费、支付、开始时间、结束时间和当前状态。用户可在有效记录中切换当前等级。

使用教程：创建会员等级

1. 进入 控制台 > 会员管理 > 会员等级。

2. 点击新增等级。

3. 填写等级名称、图标、描述、绑定角色、价格、有效期、排序和状态。

4. 配置权益：

   • 设置消费折扣，比如 90 表示九折。

   • 设置推荐福利折扣，比如 95 表示被推荐者享受九五折。

   • 设置邀请访问、邀请注册、邀请购买奖励。

   • 设置推荐码使用次数限制。

5. 保存。

使用教程：配置默认等级和过期任务

1. 进入插件设置。

2. 打开 通用设置 > 等级设置。

3. 使用 一键设置默认等级 为新注册会员指定默认等级。

4. 配置过期提醒天数。

5. 配置过期检查定时任务和过期提醒定时任务。

6. 如需等级过期后自动切换，打开 自动切换等级。

注意事项

• 等级绑定的 Halo 角色会影响内容权限，别随手绑定管理员角色，吓人得很。

• 有效期设置为 0 时表示长期有效。

• 等级记录是审计依据，别把等级记录当作临时缓存乱删。

4. 充值、支付与卡密

功能介绍

插件提供两类充值入口：

• 在线充值：依赖可选支付插件 PluginPayment，创建支付订单并定时同步支付状态。

• 卡密充值：管理员生成卡密，用户在用户中心输入卡密兑换积分或储值账户额度。

卡密由 MemberRechargeCard 承载，支持单张创建、批量创建、导出、编辑、删除和兑换。卡密类型包括积分充值和储值账户充值，其中储值账户卡密需要先启用储值账户能力和储值账户卡密开关。

使用教程：启用在线充值

1. 安装并配置支付插件 PluginPayment。

2. 进入会员插件设置。

3. 打开 支付设置 > 是否开启支付。

4. 选择支付宝或微信支付渠道。

5. 配置支付订单同步定时任务。

6. 用户进入 用户中心 > 会员管理 > 概览，点击充值，填写金额并跳转支付。

使用教程：生成卡密

1. 进入 控制台 > 会员管理 > 卡密管理。

2. 点击 批量生成 或 新增。

3. 选择卡密类型：

   • 积分充值。

   • 储值账户充值，前提是已启用储值账户卡密。

4. 设置面值、数量、有效期、是否启用。

5. 保存后可复制或导出卡密。

使用教程：用户兑换卡密

1. 用户进入 用户中心 > 会员管理 > 概览。

2. 打开充值弹窗。

3. 切换到卡密兑换。

4. 输入卡密并提交。

5. 系统校验卡密状态、有效期和使用状态，成功后写入交易流水。

注意事项

• 已使用卡密不允许删除。

• 已使用卡密只允许修改备注等非关键字段。

• 储值账户充值是资质路径能力，不确认资质别开，真别硬上。

5. 邀请推荐增长闭环

功能介绍

邀请推荐围绕推荐码展开，覆盖三条链路：

• 邀请注册：访问 /member/register?refcode=推荐码 后进入注册流程。

• 邀请访问：访问 /member/visit?refcode=推荐码 后记录访问推荐。

• 邀请购买：推荐码可参与购买折扣计算和购买奖励。

推荐码由 MemberReferralCode 承载，包含推荐码、所属用户、最大使用次数、当前使用次数、注册数、购买数、访问数、启用状态和有效期。

推荐记录由 MemberReferralRecord 承载，记录 VISIT、REGISTER、PURCHASE 三种行为，以及奖励值、奖励处理状态、被推荐者信息、IP、设备指纹等。

使用教程：配置邀请注册

1. 进入插件设置。

2. 打开 邀请设置 > 邀请注册设置。

3. 开启 启用邀请注册。

4. 设置 注册必须输入邀请码：

   • 开启：用户注册前必须填写邀请码并校验通过。

   • 关闭：邀请码选填。用户填写邀请码时走校验和推荐记录流程；留空时不校验邀请码，正常注册。

5. 设置自动处理奖励、IP 小时限制、IP 日限制、设备日限制和重复检测。

6. 如需自定义邀请码输入页，配置邀请页面模板。

使用教程：用户创建和分享推荐码

1. 用户进入 用户中心 > 会员管理 > 概览。

2. 点击创建推荐码，可自定义推荐码，也可由系统生成。

3. 创建后复制推荐链接：

   • 邀请注册链接。

   • 邀请访问链接。

   • 邀请购买链接。

4. 分享给被推荐用户。

使用教程：后台管理推荐码与推荐记录

1. 进入 控制台 > 会员管理 > 推荐码，查看推荐码列表。

2. 可按推荐码、所属用户、启用状态、有效期筛选。

3. 进入 推荐记录 查看访问、注册、购买行为记录。

4. 查看奖励状态，如未自动处理，可结合业务排查奖励处理任务。

防刷规则

邀请注册和邀请访问均有频率限制与重复检测能力：

• IP 小时限制。

• IP 日限制。

• 设备日限制。

• 同一邀请码下重复 IP 或设备检测。

• 推荐码有效期和最大使用次数校验。

注意事项

• 删除已使用的推荐码会被拒绝。

• 推荐码折扣和奖励来自推荐者当前会员等级权益。

• 推荐码校验失败时不会进入推荐奖励流程。

6. 签到、补签与前台小组件

功能介绍

签到功能用于提升用户活跃度。用户每天可签到一次，系统按配置发放基础积分奖励和可选储值账户奖励；连续签到可配置额外奖励；补签可配置消耗积分或储值账户额度。

签到记录由 MemberSignInRecord 承载，记录签到日期、连续天数、积分奖励、储值账户奖励、是否补签、创建时间等信息。

使用教程：配置签到

1. 进入插件设置。

2. 打开 签到设置 > 启用签到功能。

3. 设置每日签到基础积分。

4. 如启用储值账户能力，可设置每日签到基础储值账户奖励。

5. 如需连续签到奖励，开启连续奖励并添加奖励规则。

6. 如需补签，开启补签功能，设置补签方式、补签消耗、每月最大补签次数和补签日期范围。

7. 如需前台按钮，开启前台签到能力和默认签到按钮。

使用教程：用户签到

1. 用户进入 用户中心 > 会员管理 > 签到记录。

2. 查看今日签到状态和连续签到天数。

3. 点击立即签到。

4. 查看签到奖励和签到记录。

5. 如启用补签，可对允许范围内的漏签日期执行补签。

前台小组件

插件会按配置自动向主题页面注入 member-sign-in-widget.js，并暴露：

window.memberSignIn
window.memberSignInWidget

站点可以选择使用插件默认浮动按钮，也可以关闭默认按钮，仅保留全局函数给主题自定义 UI。

注意事项

• 补签会消耗积分或储值账户额度，具体取决于配置。

• 储值账户补签消耗同样属于资质路径能力。

• 如果主题自定义签到按钮，不要重复手动引入插件静态脚本。

7. 内容收藏能力

功能介绍

内容收藏用于文章页收藏。插件在识别到文章上下文时，会根据收藏设置自动注入收藏脚本，并提供默认收藏按钮或全局函数。用户收藏记录会在用户中心展示，后台也可以统一查询和删除。

收藏记录由 MemberContentFavorite 承载，包含用户、内容类型、内容资源名、标题、链接、封面、收藏状态和时间等信息。

使用教程：启用文章收藏

1. 进入插件设置。

2. 打开 收藏设置。

3. 开启 启用前台文章收藏能力。

4. 如希望插件自动显示按钮，开启 显示插件默认收藏按钮。

5. 如主题自行设计按钮，关闭默认按钮即可，全局函数仍可用。

用户使用流程

1. 用户打开文章详情页。

2. 点击收藏按钮。

3. 再次点击可取消收藏。

4. 进入 用户中心 > 会员管理 > 我的收藏 查看收藏列表。

后台管理

1. 收藏记录可通过公开统计接口展示收藏数。

2. 管理员可在后台查看收藏记录。

3. 对异常记录可以执行删除。

主题对接

脚本加载后会暴露：

window.memberFavorite
window.memberFavoriteWidget

主题可调用 getSummary、getStatus、toggle 等能力。更完整的主题示例见 主题对接文档。

8. 交易流水与产品插件积分兑换

功能介绍

交易流水记录所有积分和储值账户变化。交易类型包括邀请奖励、手动增减、签到奖励、补签消耗、卡密充值、会员升级消费、充值、提现、积分划转、产品订单积分兑换等。

交易记录由 MemberTransactionRecord 承载，包含用户、交易类型、状态、金额、描述、业务类型、业务 ID、外部交易号、客户端 IP、扩展数据、完成时间、创建时间和更新时间。

使用教程：查询交易记录

1. 后台进入 控制台 > 会员管理 > 交易记录。

2. 按用户、交易类型、状态、日期范围筛选。

3. 查看金额正负方向和关联业务 ID。

4. 用户可在 用户中心 > 会员管理 > 交易记录 查看自己的流水。

产品插件积分兑换对接

会员插件提供产品订单积分兑换接口，产品插件可通过服务令牌调用：

1. 进入插件设置。

2. 打开 通用设置 > 产品插件集成。

3. 开启 启用产品插件积分兑换接入。

4. 配置足够复杂的内部调用令牌。

5. 产品插件请求公开积分兑换接口时携带请求头：

X-Muyin-Member-Token: <内部调用令牌> 

成功兑换会扣减用户积分，并写入 SCORE_PRODUCT_REDEMPTION 交易流水。

注意事项

• 产品插件内部令牌只能用于服务端调用，别写到前台页面里，不然等于把钥匙挂门口。

• 积分兑换商品或权益应走积分兑换订单，不要先把积分划到储值账户再消费。

• 后台手动创建或修改储值账户流水时，会校验储值账户能力是否启用。

9. 设置、定时任务与通知

功能介绍

插件通过设置表单控制功能开关和运营参数。设置变更后，SettingToolsReconciler 会同步配置缓存，并重新注册相关定时任务。

当前自动化任务包括：

通知资源包括：

• 会员等级相关通知。

• 会员推荐注册成功通知。

• 会员充值相关通知。

使用教程：配置定时任务

1. 进入插件设置。

2. 在 通用设置 > 等级设置 配置：

   • 过期检查定时任务。

   • 过期提醒定时任务。

   • 过期提醒天数。

3. 在 支付设置 配置支付订单同步定时任务。

4. 保存设置。

5. 插件会在配置变更后注册或更新任务。

设置模块速查

主题对接速查

主题侧不要手动引入会员插件脚本。插件会根据设置自动向主题页脚注入脚本。

签到全局函数：

window.memberSignIn.getConfig()
window.memberSignIn.getMergedConfig()
window.memberSignIn.getStatus()
window.memberSignIn.signIn()
window.memberSignIn.getLoginUrl()

收藏全局函数：

window.memberFavorite.getSummary()
window.memberFavorite.getStatus()
window.memberFavorite.toggle()

推荐配置：

• 想用插件默认按钮：开启对应前台能力和默认按钮。

• 想完全自定义 UI：开启对应前台能力，关闭默认按钮，在主题中调用全局函数。

• 不要重复引入 member-sign-in-widget.js 或 member-favorite-widget.js。

运营建议

新站最小配置

1. 创建 1 个默认会员等级。

2. 在通用设置里设置默认等级。

3. 开启签到功能，先只发积分奖励。

4. 开启收藏能力，观察用户内容偏好。

5. 暂不开启储值账户、提现、积分划转，别一上来给自己找合规麻烦。

拉新配置

1. 创建至少 2 个会员等级，拉开推荐权益差异。

2. 开启邀请注册。

3. 根据站点策略决定邀请码是否必填。

4. 开启重复检测和 IP/设备频率限制。

5. 在用户中心引导用户创建推荐码。

6. 通过推荐记录和概览看板观察注册转化。

付费配置

1. 安装并配置支付插件。

2. 开启支付设置，选择支付渠道。

3. 创建付费会员等级。

4. 配置等级权益和有效期。

5. 开启支付状态同步任务。

6. 观察等级记录和交易流水。

产品积分兑换配置

1. 开启产品插件积分兑换接入。

2. 配置内部调用令牌。

3. 在产品插件侧配置相同令牌。

4. 产品订单用积分兑换时调用会员插件接口扣减积分。

5. 用交易流水核对 SCORE_PRODUCT_REDEMPTION 记录。

风险提醒

• 储值账户、余额充值、提现、积分划转属于资质路径能力，开启前先确认站点是否具备对应条件。

• 推荐奖励别配得太猛，尤其是邀请访问奖励，防刷也扛不住离谱的激励。

• 推荐码必填适合封闭注册或邀请制社区；公开站点更适合“邀请码选填”。

• 卡密适合活动发放和线下兑换，但要控制有效期和批次数量。