🔍
进度
0%
📖 文档说明

本文档描述了智慧校园PRO微信小程序的所有后端API接口。接口基础URL为 /api/v1/,所有接口返回统一JSON格式。

关键设计:

  • 用户Token直接使用微信openid,登录后返回,后续请求通过Header传递
  • 用户ID(user_id)为6位数字(100000-999999),由前端生成并传入,不可使用靓号
  • 所有时间字段使用 datetime 格式(YYYY-MM-DD HH:MM:SS)
  • 分页参数统一使用 page(页码,从1开始)和 page_size(每页数量,默认20)
  • 每个接口卡片右上角有完成勾选框,状态自动保存到浏览器本地
🔐 鉴权说明

Token机制:用户通过微信登录后获取openid作为token。后续所有需要鉴权的请求,必须在HTTP Header中携带:

Authorization: Bearer {openid}
                        // 或者使用自定义Header
            Token: {openid}

鉴权流程:

  1. 前端调用 wx.login() 获取微信code
  2. 将code发送到后端 /api/v1/user/login.php
  3. 后端通过code向微信服务器换取openid
  4. 返回openid,前端存储为token
  5. 后续请求统一在Header中携带token

⚠️ 涉及用户隐私的操作必须携带有效token,公开接口(如学校列表)无需鉴权。

⚠️ 统一响应格式 & 通用错误码

成功响应:

{ "code": 0, "message": "success", "data": { ... } }

失败响应:

{ "code": 1001, "message": "错误描述", "data": null }
错误码说明
0成功
1001参数缺失或格式错误
1002Token无效或已过期
1003用户不存在
1004权限不足
1005验证码错误或已过期
1006手机号/邮箱已被绑定
1007用户已被封禁
1008学校不存在或已禁用
1009操作频率过高
1010VIP已过期
1011用户ID已被占用
1012用户ID为靓号
9999服务器内部错误