pangu-user-platform/docs/接口清单.md

盘古用户认证中心 - 接口清单

本文档列出系统所有接口的地址和说明
作者: pangu
更新日期: 2026-02-03

---

一、H5端接口

1.1 H5认证接口

接口说明	请求方式	接口地址
获取图形验证码	GET	/h5/auth/captcha
发送短信验证码	POST	/h5/auth/sms/send
密码登录	POST	/h5/auth/login/password
短信验证码登录	POST	/h5/auth/login/sms
会员注册	POST	/h5/auth/register
刷新Token	POST	/h5/auth/refresh
退出登录	POST	/h5/auth/logout
获取微信扫码登录二维码	GET	/h5/auth/wechat/qrcode
查询微信扫码状态	GET	/h5/auth/wechat/status/{ticket}
微信扫码登录	POST	/h5/auth/wechat/login
发送微信绑定手机号短信验证码	POST	/h5/auth/wechat/sms/send
微信登录绑定手机号	POST	/h5/auth/wechat/bindPhone
微信回调处理	GET	/h5/auth/wechat/callback
清除短信限制（调试用）	DELETE	/h5/auth/debug/sms-limit/{phone}

1.2 H5会员接口

接口说明	请求方式	接口地址
获取当前会员信息	GET	/h5/member/info
修改会员基本信息	PUT	/h5/member/info
修改登录密码	PUT	/h5/member/password
添加教育身份	POST	/h5/member/educations
获取教育身份列表	GET	/h5/member/educations
修改教育身份	PUT	/h5/member/educations/{educationId}
删除教育身份	DELETE	/h5/member/educations/{educationId}
设置默认教育身份	PUT	/h5/member/educations/{educationId}/default
绑定学生	POST	/h5/member/student
获取绑定的学生列表	GET	/h5/member/students
修改学生信息	PUT	/h5/member/student/{studentId}
解绑学生	DELETE	/h5/member/student/{studentId}
获取操作日志列表	GET	/h5/member/logs

1.3 H5基础数据接口

接口说明	请求方式	接口地址
获取区域树	GET	/h5/base/regions
根据区域获取学校列表	GET	/h5/base/schools
根据学校获取年级列表	GET	/h5/base/grades
根据年级获取班级列表	GET	/h5/base/classes
获取学科列表	GET	/h5/base/subjects

---

二、管理后台接口

2.1 认证接口

接口说明	请求方式	接口地址
获取图形验证码	GET	/auth/code
管理后台登录	POST	/auth/login
退出登录	POST	/auth/logout
用户注册	POST	/auth/register
获取第三方登录跳转URL	GET	/auth/binding/{source}
前端回调绑定授权	POST	/auth/social/callback
取消第三方授权	DELETE	/auth/unlock/{socialId}
获取租户列表	GET	/auth/tenant/list

2.2 验证码接口

接口说明	请求方式	接口地址
发送短信验证码	GET	/resource/sms/code
发送邮箱验证码	GET	/resource/email/code

---

三、业务管理接口

3.1 会员管理

接口说明	请求方式	接口地址
查询会员列表	GET	/business/member/list
获取会员详情	GET	/business/member/{memberId}
新增会员	POST	/business/member
修改会员	PUT	/business/member
删除会员	DELETE	/business/member/{memberIds}
重置会员密码	PUT	/business/member/resetPwd/{memberId}
修改会员状态	PUT	/business/member/changeStatus
检查手机号是否唯一	GET	/business/member/checkPhoneUnique
获取会员已绑定的学生列表	GET	/business/member/{memberId}/students
批量绑定学生到会员	POST	/business/member/{memberId}/bindStudents
解绑学生	POST	/business/member/{memberId}/unbindStudent/{studentId}
获取会员教育身份列表	GET	/business/member/{memberId}/educations
添加教育身份	POST	/business/member/{memberId}/educations
修改教育身份	PUT	/business/member/{memberId}/educations/{educationId}
删除教育身份	DELETE	/business/member/{memberId}/educations/{educationId}
设置默认教育身份	PUT	/business/member/{memberId}/educations/{educationId}/default

3.2 学生管理

接口说明	请求方式	接口地址
查询学生列表	GET	/business/student/list
获取学校树结构	GET	/business/student/schoolTree
获取学生详情	GET	/business/student/{studentId}
新增学生	POST	/business/student
修改学生	PUT	/business/student
删除学生	DELETE	/business/student/{studentIds}
查询可绑定的学生列表	GET	/business/student/available
查询会员已绑定的学生列表	GET	/business/student/byMember/{memberId}
下载学生导入模板	GET	/business/student/template
批量导入学生	POST	/business/student/import

3.3 学校管理

接口说明	请求方式	接口地址
查询学校列表（分页）	GET	/business/school/list
查询学校列表（全部）	GET	/business/school/listAll
获取学校树形结构	GET	/business/school/tree
获取学校详情	GET	/business/school/{schoolId}
新增学校	POST	/business/school
修改学校	PUT	/business/school
删除学校	DELETE	/business/school/{schoolIds}
获取学校的年级列表	GET	/business/school/{schoolId}/grades
获取年级下的班级列表	GET	/business/school/grade/{schoolGradeId}/classes
为学校添加年级	POST	/business/school/grade
为年级添加班级	POST	/business/school/class
删除学校下的年级	DELETE	/business/school/grade/{schoolGradeId}
删除年级下的班级	DELETE	/business/school/class/{schoolClassId}

3.4 区域管理

接口说明	请求方式	接口地址
查询区域列表	GET	/business/region/list
获取区域树	GET	/business/region/tree
获取子区域列表	GET	/business/region/children/{parentId}
获取区域详情	GET	/business/region/{regionId}
获取区域路径	GET	/business/region/{regionId}/path
新增区域	POST	/business/region
修改区域	PUT	/business/region
删除区域	DELETE	/business/region/{regionIds}

3.5 年级管理

接口说明	请求方式	接口地址
查询年级列表（分页）	GET	/business/grade/list
查询年级列表（全部）	GET	/business/grade/listAll
获取年级详情	GET	/business/grade/{gradeId}
新增年级	POST	/business/grade
修改年级	PUT	/business/grade
删除年级	DELETE	/business/grade/{gradeIds}

3.6 班级管理

接口说明	请求方式	接口地址
查询班级列表（分页）	GET	/business/class/list
查询班级列表（全部）	GET	/business/class/listAll
获取班级详情	GET	/business/class/{classId}
新增班级	POST	/business/class
修改班级	PUT	/business/class
删除班级	DELETE	/business/class/{classIds}

3.7 学科管理

接口说明	请求方式	接口地址
查询学科列表（分页）	GET	/business/subject/list
查询学科列表（全部）	GET	/business/subject/listAll
获取学科详情	GET	/business/subject/{subjectId}
新增学科	POST	/business/subject
修改学科	PUT	/business/subject
删除学科	DELETE	/business/subject/{subjectIds}

3.8 第三方应用管理

接口说明	请求方式	接口地址
查询应用列表	GET	/business/application/list
获取应用详情	GET	/business/application/{appId}
新增应用	POST	/business/application
修改应用	PUT	/business/application
删除应用	DELETE	/business/application/{appIds}
重置应用密钥	PUT	/business/application/resetSecret/{appId}
获取API接口列表	GET	/business/application/apiList

---

四、系统管理接口

4.1 用户管理

接口说明	请求方式	接口地址
获取用户列表	GET	/system/user/list
导出用户列表	POST	/system/user/export
导入用户数据	POST	/system/user/importData
获取导入模板	POST	/system/user/importTemplate
获取当前登录用户信息	GET	/system/user/getInfo
获取用户详情	GET	/system/user/{userId}
新增用户	POST	/system/user
修改用户	PUT	/system/user
删除用户	DELETE	/system/user/{userIds}
批量获取用户基础信息	GET	/system/user/optionselect
重置用户密码	PUT	/system/user/resetPwd
修改用户状态	PUT	/system/user/changeStatus
获取用户授权角色	GET	/system/user/authRole/{userId}
用户授权角色	PUT	/system/user/authRole
获取部门树列表	GET	/system/user/deptTree
获取部门下的所有用户	GET	/system/user/list/dept/{deptId}

4.2 角色管理

接口说明	请求方式	接口地址
获取角色列表	GET	/system/role/list
导出角色列表	POST	/system/role/export
获取角色详情	GET	/system/role/{roleId}
新增角色	POST	/system/role
修改角色	PUT	/system/role
修改数据权限	PUT	/system/role/dataScope
修改角色状态	PUT	/system/role/changeStatus
删除角色	DELETE	/system/role/{roleIds}
获取角色选择框列表	GET	/system/role/optionselect
查询已分配用户列表	GET	/system/role/authUser/allocatedList
查询未分配用户列表	GET	/system/role/authUser/unallocatedList
取消授权用户	PUT	/system/role/authUser/cancel
批量取消授权用户	PUT	/system/role/authUser/cancelAll
批量选择用户授权	PUT	/system/role/authUser/selectAll
获取角色部门树列表	GET	/system/role/deptTree/{roleId}

4.3 部门管理

接口说明	请求方式	接口地址
获取部门列表	GET	/system/dept/list
查询部门列表（排除节点）	GET	/system/dept/list/exclude/{deptId}
获取部门详情	GET	/system/dept/{deptId}
新增部门	POST	/system/dept
修改部门	PUT	/system/dept
删除部门	DELETE	/system/dept/{deptId}
获取部门选择框列表	GET	/system/dept/optionselect

4.4 菜单管理

接口说明	请求方式	接口地址
获取路由信息	GET	/system/menu/getRouters
获取菜单列表	GET	/system/menu/list
获取菜单详情	GET	/system/menu/{menuId}
获取菜单下拉树列表	GET	/system/menu/treeselect
加载角色菜单列表树	GET	/system/menu/roleMenuTreeselect/{roleId}
加载租户套餐菜单列表树	GET	/system/menu/tenantPackageMenuTreeselect/{packageId}
新增菜单	POST	/system/menu
修改菜单	PUT	/system/menu
删除菜单	DELETE	/system/menu/{menuId}
批量级联删除菜单	DELETE	/system/menu/cascade/{menuIds}

4.5 字典类型管理

接口说明	请求方式	接口地址
查询字典类型列表	GET	/system/dict/type/list
导出字典类型列表	POST	/system/dict/type/export
获取字典类型详情	GET	/system/dict/type/{dictId}
新增字典类型	POST	/system/dict/type
修改字典类型	PUT	/system/dict/type
删除字典类型	DELETE	/system/dict/type/{dictIds}
刷新字典缓存	DELETE	/system/dict/type/refreshCache
获取字典选择框列表	GET	/system/dict/type/optionselect

4.6 字典数据管理

接口说明	请求方式	接口地址
查询字典数据列表	GET	/system/dict/data/list
导出字典数据列表	POST	/system/dict/data/export
获取字典数据详情	GET	/system/dict/data/{dictCode}
根据字典类型查询字典数据	GET	/system/dict/data/type/{dictType}
新增字典数据	POST	/system/dict/data
修改字典数据	PUT	/system/dict/data
删除字典数据	DELETE	/system/dict/data/{dictCodes}

4.7 岗位管理

接口说明	请求方式	接口地址
获取岗位列表	GET	/system/post/list
导出岗位列表	POST	/system/post/export
获取岗位详情	GET	/system/post/{postId}
新增岗位	POST	/system/post
修改岗位	PUT	/system/post
删除岗位	DELETE	/system/post/{postIds}
获取岗位选择框列表	GET	/system/post/optionselect
获取部门树列表	GET	/system/post/deptTree

4.8 参数配置管理

接口说明	请求方式	接口地址
获取参数配置列表	GET	/system/config/list
导出参数配置列表	POST	/system/config/export
获取参数配置详情	GET	/system/config/{configId}
根据参数键名查询参数值	GET	/system/config/configKey/{configKey}
新增参数配置	POST	/system/config
修改参数配置	PUT	/system/config
根据参数键名修改参数配置	PUT	/system/config/updateByKey
删除参数配置	DELETE	/system/config/{configIds}
刷新参数缓存	DELETE	/system/config/refreshCache

4.9 通知公告管理

接口说明	请求方式	接口地址
获取通知公告列表	GET	/system/notice/list
获取通知公告详情	GET	/system/notice/{noticeId}
新增通知公告	POST	/system/notice
修改通知公告	PUT	/system/notice
删除通知公告	DELETE	/system/notice/{noticeIds}

---

五、日志监控接口

5.1 操作日志

接口说明	请求方式	接口地址
获取操作日志列表	GET	/monitor/operlog/list
导出操作日志列表	POST	/monitor/operlog/export
删除操作日志	DELETE	/monitor/operlog/{operIds}
清理操作日志	DELETE	/monitor/operlog/clean

5.2 登录日志

接口说明	请求方式	接口地址
获取登录日志列表	GET	/monitor/logininfor/list
导出登录日志列表	POST	/monitor/logininfor/export
删除登录日志	DELETE	/monitor/logininfor/{infoIds}
清理登录日志	DELETE	/monitor/logininfor/clean
账户解锁	GET	/monitor/logininfor/unlock/{userName}

5.3 在线用户

接口说明	请求方式	接口地址
获取在线用户列表	GET	/monitor/online/list
强退用户	DELETE	/monitor/online/{tokenId}
获取当前用户登录设备	GET	/monitor/online
强退当前在线设备	DELETE	/monitor/online/myself/{tokenId}

---

六、接口统计

模块	接口数量
H5认证接口	14
H5会员接口	13
H5基础数据接口	5
管理后台认证接口	10
会员管理	16
学生管理	10
学校管理	13
区域管理	8
年级管理	6
班级管理	6
学科管理	6
第三方应用管理	7
用户管理	16
角色管理	16
部门管理	7
菜单管理	10
字典类型管理	8
字典数据管理	7
岗位管理	8
参数配置管理	9
通知公告管理	5
操作日志	4
登录日志	5
在线用户	4
总计	203*