← 返回雾角社区首页

雾角社区 API 开发文档 V1.1

技术栈：PHP 7.4 + MySQL 8.0 + PDO 预处理 | 适用：网页端 / AndLua / LuaAppx / ManaLua / 安卓APP 对接

一、基础通用规范

接口访问规范

1. 接口基础访问地址：https://wjord.cn/api/接口文件名.php

2. 默认请求方式：POST（参数拼接到 URL 用 & 连接，放入请求体）；删除类接口为 GET（参数直接拼在 URL 后面）

3. POST 请求头：Content-Type: application/x-www-form-urlencoded

4. 全局统一返回 JSON 结构：

返回 JSON 结构

{"code":200,"msg":"操作成功","data":{},"url":"login.php"}

注意：admin_user_del.php 与 admin_banner_del.php 为 GET 接口，参数用 ? 和 & 直接拼在 URL 后；其余接口统一为 POST，参数放入请求体。

二、全局状态码对照表

状态码 code	业务含义	处理建议
200	操作成功，正常返回业务数据	读取 data 字段渲染业务
400	参数缺失/格式错误/验证码失效/账号已注册或不存在/密码长度不足	弹出 msg 提示用户
401	未登录或登录会话失效	跳转登录页重新登录
500	数据库连接失败 / 邮件发送失败 / 服务端异常	检查 config.php 与 SMTP 配置

三、前台用户接口

1. 注册发送邮箱验证码 POST /api/send_code.php

作用：校验邮箱合法性，生成 6 位验证码存入数据库并发送邮件，已注册邮箱直接拦截。

参数名	类型	必填	说明
email	string	是	注册邮箱地址

请求示例

POST https://wjord.cn/api/send_code.php?email=123456@qq.com

2. 用户账号注册 POST /api/register.php

作用：校验验证码、用户名/邮箱唯一性，密码使用 password_hash 加密入库，注册成功自动清除验证码。

参数名	类型	必填	说明
username	string	是	用户名，2~50 字符
email	string	是	注册邮箱
code	string	是	6 位数字邮箱验证码
password	string	是	登录密码，≥6 位

请求示例

POST https://wjord.cn/api/register.php?username=雾角玩家&email=123456@qq.com&code=123456&password=666888

成功返回

{"code":200,"msg":"注册成功","url":"login.php"}

3. 用户账号登录 POST /api/login.php

作用：校验邮箱与加密密码，验证通过写入 Session，返回用户基础信息。

参数名	类型	必填	说明
email	string	是	注册绑定邮箱
password	string	是	账户登录明文密码

请求示例

POST https://wjord.cn/api/login.php?email=123456@qq.com&password=666888

4. 找回密码获取验证码 POST /api/forget_code.php

作用：仅允许已注册邮箱获取重置验证码，过期验证码自动清理。

参数名	类型	必填	说明
email	string	是	注册邮箱

请求示例

POST https://wjord.cn/api/forget_code.php?email=123456@qq.com

5. 密码重置 POST /api/reset_password.php

作用：验证重置验证码，更新数据库加密密码，完成后销毁验证码。

参数名	类型	必填	说明
email	string	是	注册邮箱
code	string	是	6 位重置验证码
new_password	string	是	新登录密码，≥6 位

请求示例

POST https://wjord.cn/api/reset_password.php?email=123456@qq.com&code=123456&new_password=777999

6. 找回账号发送验证码 POST /api/find_account_code.php

作用：校验邮箱是否注册，发送 6 位账号查询验证码，仅已注册邮箱可获取。

参数名	类型	必填	说明
email	string	是	注册绑定邮箱

请求示例

POST https://wjord.cn/api/find_account_code.php?email=123456@qq.com

7. 找回账号查询 POST /api/find_account_submit.php

作用：校验验证码后返回用户 UID 与用户名，不返回任何密码信息，校验通过销毁验证码。

参数名	类型	必填	说明
email	string	是	注册邮箱
code	string	是	6 位邮箱验证码

请求示例

POST https://wjord.cn/api/find_account_submit.php?email=123456@qq.com&code=123456

8. 获取当前登录用户信息 POST /api/user_info.php

权限：登录用户 | 作用：读取个人中心全部资料。无请求参数。

返回 data 字段	说明
id	用户唯一 ID
username	用户名
email	绑定邮箱
avatar	头像图片链接，空则前端使用默认头像
sign	个性签名
create_time	注册日期 Y-m-d

请求示例

POST https://wjord.cn/api/user_info.php

9. 修改用户资料 POST /api/user_update.php

权限：登录用户 | 作用：修改用户名、个性签名，自动校验用户名重复。

参数名	必填	说明
username	是	2~50 字符
sign	是	最多 200 字，空字符串清空签名

请求示例

POST https://wjord.cn/api/user_update.php?username=新昵称&sign=测试个性签名

10. 用户退出登录 POST /api/logout.php

权限：登录用户 | 无参数，销毁前台用户 Session。

请求示例

POST https://wjord.cn/api/logout.php

11. 首页轮播图读取 GET /api/home_banner.php

权限：全部游客可访问 | 作用：读取前台启用的轮播图，按 sort 降序排列。无请求参数。

返回 data 单条字段	说明
img_url	轮播图片地址
link_url	点击跳转链接，空则无跳转

请求示例

GET https://wjord.cn/api/home_banner.php

四、后台管理员接口（需后台登录 Session）

1. 后台管理员登录 POST /api/admin_login.php

参数	必填	说明
username	是	后台管理员账号
password	是	后台登录密码

请求示例

POST https://wjord.cn/api/admin_login.php?username=admin&password=123456

2. 后台控制台统计 POST /api/admin_dash.php

无参数，返回注册总用户数、启用轮播总数。

data 字段	说明
user_count	全部注册用户数量
banner_count	status=1 的轮播图数量

请求示例

POST https://wjord.cn/api/admin_dash.php

3. 获取全部用户列表 POST /api/admin_user_list.php

无参数，返回所有用户 ID、用户名、邮箱、签名、注册日期，按 ID 倒序。

请求示例

POST https://wjord.cn/api/admin_user_list.php

4. 删除用户 GET /api/admin_user_del.php

参数	必填	说明
uid	是	待删除用户 ID（GET 参数）

请求示例

GET https://wjord.cn/api/admin_user_del.php?uid=10

5. 后台轮播列表 POST /api/admin_banner_list.php

无参数，返回全部轮播（包含关闭状态），按 sort 从大到小排序。

单条 data 字段	说明
id	轮播 ID
img_url	图片地址
link_url	跳转链接
sort	排序权重，数字越大越靠前
status	1 启用 / 0 关闭
create_time	创建时间戳（Unix）

请求示例

POST https://wjord.cn/api/admin_banner_list.php

6. 新增 / 编辑轮播 POST /api/admin_banner_save.php

带 id 为编辑，不带 id 为新增。

参数	必填	说明
id	否	轮播 ID，编辑时传入
img_url	是	图片网络地址，不可为空
link_url	是	空字符串代表无跳转
sort	是	数字排序权重
status	是	1 展示 / 0 隐藏

新增请求示例

POST https://wjord.cn/api/admin_banner_save.php?img_url=https://test.jpg&link_url=index.html&sort=3&status=1

编辑请求示例

POST https://wjord.cn/api/admin_banner_save.php?id=5&img_url=https://test2.jpg&link_url=detail.html&sort=5&status=1

7. 删除轮播 GET /api/admin_banner_del.php

参数	必填	说明
id	是	轮播图 ID（GET 参数）

请求示例

GET https://wjord.cn/api/admin_banner_del.php?id=3

8. 后台退出登录 POST /api/admin_logout.php

无参数，销毁后台管理员 Session。

请求示例

POST https://wjord.cn/api/admin_logout.php

五、客户端对接拓展说明

1. 网页端使用 Session 维持登录状态，移动端脚本/APP 无 Session 环境，后续可扩展 Token 登录接口；

2. 前台用户密码采用 PHP 原生 password_hash bcrypt 加密，不可逆；后台管理员密码当前为明文比对，上线前需改为哈希校验；

3. 验证码统一 5 分钟（300 秒）有效期，超时自动失效；

4. 数据库全部使用 PDO 预处理 SQL，杜绝 SQL 注入风险；

5. 邮件发送基于原生 socket 实现，无需第三方 PHPMailer 类库，PHP 7.4 原生兼容；

6. 后台轮播完全可视化管理，前台自动读取启用数据，无需修改前端页面；

7. 部分接口返回 url 字段作为前端跳转建议，无强制要求。

六、数据库结构参考

user 用户表：id / username / email / password / avatar / sign / create_time

admin 管理员表：id / username / password

banner 轮播图表：id / img_url / link_url / sort / status / create_time

email_verify_code 验证码表：id / email / code / expire_time

雾角社区 API 开发文档 V1.1 | 技术栈：PHP 7.4 + MySQL 8.0 | 文档更新时间：2026