XN API插件使用文档

一、插件简介

XN API 插件是基于 HadSky 论坛系统的客户端接口插件，为配套的 uniAPP 客户端（XN_UniAPP）提供数据接口服务，插件涵盖付费阅读、卡密兑换、签到抽奖、内容管理、用户管理、版块管理、举报管理、私信管理、多用户审核等全量功能。

二、运行环境与编译工具

项目    要求

主程序    HadSky 7.10.0 及以上版本

PHP    7.4 及以上

数据库    MySQL 5.7 及以上

站点    已配置 HTTPS 证书

编译工具HBuilderX：https://www.dcloud.io/hbuilderx.html（对接编译源码需要用到）

三、安装步骤与常见问题

1.插件安装时需验证站点与 HadSky 云服务是否互通，未登录云服务的站点无法安装插件，安装前请确保站点与 HadSky 云端互通

2.关于验证码不显示的问题请检查验证码插件是否开启，测试7.x版本需要手动开启验证码插件，8.X版本开不开都不影响登录验证码的显示（视实际情况操作）

3.安装教程文档：https://docs.qq.com/doc/DWEJ5V2Z0aEVMZ3RF，APP源码下载地址在购买安装插件后在该插件的设置页面获取，因图文限制的问题，用腾讯文档写了详细的安装步骤，基本上一个操作一张截图，从插件安装到源码打包生成一应俱全，跟着步骤做很简单。

四、功能说明

【前台功能】

1.首页页面：轮番图支持自定义帖子，首页五格支持自定义图标和跳转链接或客户端站内页面；

2.搜索功能：支持搜索全站帖子、指定版块帖子、指定用户帖子；

3.动态列表：动态列表支持筛选最新帖子、最后回复、精华帖子、我的关注；

4.帖子详情：支持点赞、收藏帖子、打赏天豆、附件独立下载页、插入阅读权限（天豆、经验、权限值）、帖子操作方面支持动态置顶、版块置顶、加精、锁定、编辑、举报帖子；

5.帖子评论：同样支持打赏天豆、删除、举报，并且新增了评论置顶功能，每帖可以置顶3条评论；

6.版块页面：支持版块帖子独立置顶区、版块分类标签、版块独立信息页（包含版块名称、话题、热度，版主栏、版块介绍），以及可以直接在版块信息页操作新增版块、删除版块、编辑版块（支持设置版主、版块分类标签、版块名称、排序、版块介绍、以及删除变更版块图标）；

7.消息盒子：有独立的私信消息列表、私信消息与系统消息分隔、支持单方面删除私信记录（删除后自己看不到但是对方依然可以看到），并且管理员可以直接查看用户的私信消息记录（即使用户单方面删除记录了也能看到），同时私信记录也支持举报；

8.用户主页：支持发私信，关注对方，有独立的帖子列表、回帖列表、收藏列表、粉丝列表、关注列表，并且用户本人可以置顶3条帖子，用户主页同样支持举报功能；

9.签到功能：有独立的签到页与连续签到排行榜，并且新增了幸运大转盘抽奖功能；

10.卡密兑换：支持兑换天豆和用户组；

【后台功能】（内置管理后台）

1.全局配置：支持设置社区名称、APP的关于弹窗、私信开关、置顶帖排序方式、天豆打赏（支持自定义天豆名称）、自定义经验等级说明弹窗、封禁设置（禁止发言的用户组ID、解禁恢复到指定用户组的id，必须设置不然会影响封禁功能）、阅读权限设置（金币、权限值、经验可见最大值的限制）、远程图片权限、图片压缩、缓存设置、长按复制自带尾巴设置；

2.首页设置：支持设置顶部左侧导航logo图标、登录页logo、首页五格设置（支持上传图标或使用fa4图标）；

3.用户管理：用户列表（支持搜索、编辑、封禁、变更用户组）、用户组管理（支持新增、删除用户组、设置用户组背景颜色、权限值和相关权限配置）、支持设置隐藏用户组（被设置隐藏的用户组在特定页面不会显示标识）、会员管理（主要用户设置不同会员在独立下载页面的天豆折扣）、认证管理（可以给用户设置头像加V以及特定页面显示的昵称颜色）；

4.内容管理：话题管理(支持批量删除、移动帖子、支持根据版块筛选)、评论管理、回收站（支持恢复和永久删除）；

5、私信管理：可查看站内所有私信，可以批量删除；

6.审核管理：主题审核、评论审核、审核日志、权限配置（可以设置免审核用户组，以及是否开启审核）；

7.举报管理：可以查看帖子、评论、私信、用户的举报记录，支持筛选、批量删除；

8.权限分配：可以分配审核权限与举报处理权限给指定的用户组或者用户，实现了多用户审核；

9.APP更新:用户推送app版本更新，可选强制更新，与后台插件设置的app更新是同步的；

10.卡密管理：可以生成天豆卡密、用户组卡密（并且支持设置用户组卡密是否赠送天豆）、配置管理（支持开关卡密功能）、设置卡密页面弹窗、卡密页面更多菜单按钮、邮箱通知、站内通知管理员、卡密获取链接配置、会员组配置（按低到高排序，比如我是中级会员用户组兑换了初级会员的兑换码那么用户组不会变更，但依然赠送兑换码附带的天豆，如果我使用了高级会员兑换码那么我的用户组也会变成高级会员）；

11.流水管理：可以查看用户积分流水（打赏、支付需要天豆的帖子、兑换码兑换的天豆、签到获得的天豆、大转盘抽奖消耗，其他场景不在范围内）；

12.签到配置：可以设置是否开启签到、大转盘功能、可以设置每日签到奖励、连续签到奖励、特定用户组签到奖励倍率、活动说明、大转盘奖品和奖品概率；

13.风控系统：可以设置搜索、主页访问、帖子、图片上传等相关api请求限流；

14.H5设置：可以设置是否允许网页版登录、发帖、评论、搜索、浏览用户主页、访问版块、修改资料，以及浏览器SEO标题相关配置；

15.验证码设置：可以设置是否开启发帖验证、评论验证；

五、特别声明

本插件是基于 HadSky 论坛系统开发的第三方扩展插件。

我们尽力保障插件功能稳定可用，但无法保证插件对所有 HadSky 版本、服务器环境以及其他第三方插件完全兼容，程序也可能存在未知 Bug。

使用插件前，请务必定期备份站点文件与数据库。如因服务器环境冲突、操作失误、插件异常等情况，造成站点报错、数据异常或丢失，插件开发者不承担相关损失与赔偿责任。

本插件仅提供程序功能，站点运营、内容管理、用户交易相关事宜均由站点运营方自行负责。请您确保站点运营符合国家法律法规，若利用本插件开展违规业务，相关法律责任由使用者自行承担。

开发者保留对插件进行更新、调整或停止维护的权利。

安装并启用本插件，即代表您已阅读并同意以上特别声明。