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

适配 PHP7.4 + MySQL，接口统一POST请求，返回标准JSON，适用于网页、AndLua/LuaAppx/ManaLua客户端、安卓APP对接开发

一、基础通用规范

1. 接口基础访问地址：站点域名/api/接口文件名.php

2. 所有接口请求方式：仅支持 POST

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

4. 全局统一返回JSON结构

{
    "code": 200,
    "msg": "文本提示信息",
    "data": {}
}

说明：code=200代表操作成功；400参数/业务错误；401未登录；500服务器内部异常；失败时无data字段。

二、全局错误码对照表

状态码 code	业务含义
200	操作成功，正常返回业务数据
400	参数缺失、格式错误、验证码过期、账号已注册/不存在、密码长度不足
401	未登录/登录会话失效，需跳转登录页
500	数据库连接失败、邮件发送失败、服务端未知错误

三、前台用户接口（游客/登录用户可用）

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

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

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

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

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

参数名	数据类型	是否必填	参数说明
username	string	是	用户名，长度限制2~50字符
email	string	是	注册邮箱
code	string	是	6位数字邮箱验证码
password	string	是	登录密码，最少6位字符

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

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

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

成功返回data包含：uid(用户ID)、username(用户名)

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

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

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

5. 密码重置接口 /api/reset_password.php

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

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

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

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

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

7. 找回账号-提交查询 /api/find_account_submit.php

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

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

成功返回data字段：uid(用户ID)、username(社区昵称)

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

权限：登录用户 | 作用：读取个人中心全部资料（头像、签名、注册时间等）

无请求参数

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

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

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

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

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

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

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

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

无请求参数

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

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

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

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

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

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

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

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

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

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

请求方式GET

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

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

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

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

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

POST提交，带id为编辑，不带id为新增

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

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

GET传参

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

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

无参数，销毁后台管理员Session，跳转后台登录页

五、客户端对接拓展说明（AndLua/APP专用）

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

2. 所有密码后端采用PHP原生password_hash bcrypt加密，不可逆，前端仅传明文；

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

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

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

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