后端接口文档
栏目说明
按“一接口一文档”发布中间件后端正式 HTTP 接口，适合直接给后端、联调和验收同学阅读。
收录情况
当前栏目共收录 84 篇正式文档。
文档列表
POST · 正式接口文档新增模块用于新增模块记录，登记正式模块定义、模块标识和排序信息。进入文档DELETE · 正式接口文档删除模块用于删除模块记录。进入文档GET · 正式接口文档获取模块列表用于分页或按条件查询模块列表。进入文档PUT · 正式接口文档更新模块用于更新模块记录。进入文档POST · 正式接口文档绑定角色应用用于替换目标角色在当前模块下可绑定的应用实例列表。传空数组表示清空该角色当前模块下的应用绑定结果。进入文档POST · 正式接口文档新建角色用于新增角色记录。进入文档POST · 正式接口文档删除角色用于删除角色记录。进入文档POST · 正式接口文档获取角色关联用户用于完成“获取角色关联用户”相关的正式链路操作。进入文档POST · 正式接口文档获取角色列表用于分页或按条件查询角色列表。进入文档POST · 正式接口文档获取模块角色列表用于完成“获取模块角色列表”相关的正式链路操作。进入文档POST · 正式接口文档设置可管理角色范围用于完成“设置可管理角色范围”相关的正式链路操作。进入文档PUT · 正式接口文档更新角色用于更新角色记录。进入文档PUT · 正式接口文档修改文件名称用于完成“修改文件名称”相关的正式链路操作。进入文档POST · 正式接口文档获取文件列表用于分页或按条件查询文件列表。进入文档POST · 正式接口文档头像上传用于完成“头像上传”相关的正式链路操作。进入文档POST · 正式接口文档通用上传用于完成“通用上传”相关的正式链路操作。进入文档POST · 正式接口文档生成菜单示例用于按当前模块、清单类型和应用范围生成一份开发参考清单。该接口只返回参考内容，不保存草稿、不提交版本、不发布生效。进入文档GET · 正式接口文档获取代码动作清单角色授权状态用于读取指定运行上下文在当前模块代码动作清单下的页面码、动作码授权状态。该接口只服务代码动作清单授权场景，不作为下游业务菜单授权状态主入口。 下游业务模块…进入文档GET · 正式接口文档获取菜单版本详情用于完成“获取菜单版本详情”相关的正式链路操作。进入文档POST · 正式接口文档获取菜单发布状态获取菜单发布状态进入文档POST · 正式接口文档获取菜单运行态获取菜单运行态进入文档POST · 正式接口文档获取菜单模板用于按当前模块、清单类型和应用范围生成一份空白清单骨架。该接口只返回起稿模板，不保存草稿、不提交版本、不发布生效。进入文档POST · 正式接口文档获取菜单版本列表获取菜单版本列表进入文档POST · 正式接口文档发布菜单版本发布菜单版本进入文档POST · 正式接口文档保存代码动作清单角色授权结果用于按中间件代码动作清单中的页面码、动作码和默认页定义保存目标角色的代码清单授权结果，并同步刷新该角色在当前模块下的运行时菜单承载与 Casbin 放行结…进入文档POST · 正式接口文档提交菜单版本提交菜单版本进入文档POST · 正式接口文档更新菜单运行态显示用于更新菜单清单记录。进入文档POST · 正式接口文档上传菜单清单用于把已经通过校验的菜单清单保存为菜单版本草稿。接口会在落库前重新执行完整菜单清单校验；只要存在 blocking 阻断项，本次上传不会创建或更新版本记录…进入文档POST · 正式接口文档获取当前导航菜单返回当前会话在当前模块下已经生效的运行时菜单树。进入文档POST · 正式接口文档新增部门成员用于新增部门记录。进入文档POST · 正式接口文档新建部门用于新增部门记录，并写入可用于生成用户编号的部门编码。进入文档DELETE · 正式接口文档移除部门成员用于删除部门记录。进入文档DELETE · 正式接口文档删除部门用于删除部门记录。进入文档GET · 正式接口文档获取部门成员 ID 列表用于完成“获取部门成员 ID 列表”相关的正式链路操作。进入文档GET · 正式接口文档获取部门成员分页用于完成“获取部门成员分页”相关的正式链路操作。进入文档GET · 正式接口文档获取部门成员与权限用于完成“获取部门成员与权限”相关的正式链路操作。进入文档POST · 正式接口文档获取部门树用于获取当前操作者在中间件内可见的部门树，返回结果按“系统超级管理员 / 部门管理员 / 普通部门用户”三档规则判定。进入文档POST · 正式接口文档获取可见部门树用于获取当前操作者可见且已启用的部门树，通常用于部门选择器、弹窗树和组织范围选择控件。进入文档POST · 正式接口文档查询可添加成员用于完成“查询可添加成员”相关的正式链路操作。进入文档PUT · 正式接口文档设置部门管理员用于完成“设置部门管理员”相关的正式链路操作。进入文档PUT · 正式接口文档调动部门成员用于将用户从原部门调动到目标部门；调动成功后，会按目标部门编码修正用户编号。进入文档PUT · 正式接口文档更新部门用于更新部门基础信息，并校验可用于生成用户编号的部门编码。进入文档POST · 正式接口文档获取部门应用范围用于完成“获取部门应用范围”相关的正式链路操作。进入文档POST · 正式接口文档获取用户可用应用范围用于完成“获取用户可用应用范围”相关的正式链路操作。进入文档POST · 正式接口文档设置部门应用范围用于完成“设置部门应用范围”相关的正式链路操作。进入文档POST · 正式接口文档获取部门校区范围用于完成“获取部门校区范围”相关的正式链路操作。进入文档POST · 正式接口文档获取用户可用校区范围用于完成“获取用户可用校区范围”相关的正式链路操作。进入文档POST · 正式接口文档设置部门校区范围用于完成“设置部门校区范围”相关的正式链路操作。进入文档GET · 正式接口文档获取角色校区列表用于完成“获取角色校区列表”相关的正式链路操作。进入文档POST · 正式接口文档获取可见校区树用于完成“获取可见校区树”相关的正式链路操作。进入文档POST · 正式接口文档新增用户用于新增中间件全局用户，写入所属部门关系，并按部门编码生成用户编号。进入文档POST · 正式接口文档修改当前用户密码用于完成“修改当前用户密码”相关的正式链路操作。进入文档DELETE · 正式接口文档删除用户用于删除用户记录。进入文档GET · 正式接口文档获取当前用户资料返回当前 app-id + addons-type 下已经生效的正式运行上下文、上下文候选列表、默认页、应用菜单默认页与公共范围。进入文档POST · 正式接口文档重置用户密码用于完成“重置用户密码”相关的正式链路操作。进入文档PUT · 正式接口文档更新个人资料用于完成“更新个人资料”相关的正式链路操作。进入文档POST · 正式接口文档设置用户角色列表用于在中间件管理端维护用户的角色列表。用户和部门是全局基础数据，角色按模块归属；本接口接收的是跨模块角色 ID 列表，不受请求头 addons-type …进入文档PUT · 正式接口文档更新用户资料用于更新中间件全局用户基础资料、账号状态和所属部门；当用户编号不符合当前部门编码规则时，会在本次保存中重新生成。进入文档POST · 正式接口文档退出登录用于完成“退出登录”相关的正式链路操作。进入文档POST · 正式接口文档新建应用信息用于新增应用信息记录。进入文档DELETE · 正式接口文档删除应用信息用于删除应用信息记录。进入文档GET · 正式接口文档获取应用信息列表用于读取当前模块下的应用信息列表，供应用信息页、角色应用绑定和应用菜单治理页选择正式应用实例时复用。进入文档PUT · 正式接口文档更新应用信息用于更新应用信息记录。进入文档POST · 正式接口文档获取图形验证码用于获取 PCWEB 登录前必须校验的图形验证码。进入文档POST · 正式接口文档PCWEB登录用于 PCWEB 管理端登录，并按当前 app-id + addons-type 解析正式运行上下文。进入文档GET · 正式接口文档获取 RSA 公钥用于获取登录前端加密密码所需的 RSA 公钥。进入文档POST · 正式接口文档选择角色并完成登录用于 loginNew 返回多个候选上下文时，继续选择一个正式运行上下文并完成登录。进入文档POST · 正式接口文档切换当前运行上下文用于头部身份切换，切换当前 app-id + addons-type 下已经生效的正式运行上下文。进入文档POST · 正式接口文档permanentKey换取tempKey用于使用应用的 permanent key 换取正式运行时使用的 tempKey。应用端或服务端调用需要携带 X-App-Key 的公共认证接口前，必须先…进入文档POST · 正式接口文档服务态获取应用 AccessToken服务态获取应用 AccessToken进入文档POST · 正式接口文档复制角色用于在当前模块内创建一个新的正式角色副本，并按最终态规则复制源角色的应用绑定、可管理角色范围、正式页面/动作授权与默认页。进入文档POST · 正式接口文档按OpenID获取公众号订阅用户最小信息用于服务态在当前应用上下文内，通过绑定关系把业务 openid 映射到公众号订阅用户，并返回最小必要运行时信息。进入文档POST · 正式接口文档按UnionID获取公众号订阅用户最小信息用于服务态在当前应用上下文内，通过 unionid 获取公众号订阅用户最小运行时信息，支撑绑定桥接、登录辅助或其他已确认正式链路。进入文档POST · 正式接口文档切换当前生效菜单版本切换当前生效菜单版本进入文档POST · 正式接口文档同步微信应用支付资料用于下游业务模块按正式授权范围低频同步 app_wechat_apps_info 中的微信入口应用资料和支付主体资料。 该接口是服务态受控接口，只允许系统…进入文档正式接口文档获取系统配置摘要用于系统配置页面只读查看中间件运行配置摘要。接口只返回可展示字段和敏感项配置状态，不返回 JWT 签名密钥、Redis 密码、数据库密码、OSS 密钥、系…进入文档正式接口文档获取服务运行信息用于系统配置页面只读查看当前中间件进程和宿主资源状态。该接口不返回系统配置明文，不提供修改能力。进入文档正式接口文档保存系统配置当前中间件系统配置页面为只读页面，不允许通过 PCWEB 修改后端配置文件。本接口保留为历史兼容入口，但正式行为是拒绝页面修改请求。 配置变更应通过服务器…进入文档POST · 正式接口文档校验菜单清单用于在保存草稿前校验菜单清单正文。接口只执行解析后的正式规则校验和目标范围校验，不创建、不更新菜单版本记录。 当前接口即使发现 blocking 阻断项，…进入文档POST · 正式接口文档保存已发布菜单角色授权按当前模块已经正式发布的 system_menu 清单保存角色菜单、动作和默认页授权。该接口用于下游业务模块和显式发布到下游菜单中的公共治理入口授权，不读…进入文档POST · 正式接口文档保存应用菜单角色授权按当前模块、当前应用范围已经正式发布的 app_menu 清单保存角色移动端/应用端菜单授权和应用端默认首页。保存结果写入独立表 sys_app_menu…进入文档POST · 正式接口文档获取当前用户应用菜单授权移动端或应用端在已登录后，通过当前 token、Header app-id 和 Header addons-type 获取当前用户在当前应用下可用的 ap…进入文档GET · 正式接口文档获取已发布菜单角色授权状态读取当前模块已发布 system_menu 清单，并返回指定角色在该清单下的页面、动作、默认页和运行承载状态。该接口是下游业务菜单授权页的正式读取入口，不…进入文档POST · 正式接口文档获取应用菜单角色授权状态读取当前模块、当前应用范围下已经正式发布的 app_menu 清单，并返回指定角色在该应用菜单清单中的页面、动作、菜单标识授权状态和应用端默认首页。 该接…进入文档