1. Admin
Ai Forge
  • Admin
    • 后台API接口使用说明
    • 认证授权
      • 认证授权说明
      • 账号密码登录
      • 微信公众号登录
      • 刷新访问令牌
      • 获取当前管理员信息
      • 获取已签发的 Token 列表
      • 撤销指定的 Token
      • 退出登录
    • 公共接口
      • 文件上传
        • 获取上传Token
        • 图片上传
        • 上传文件
        • 上传视频
        • APK文件上传
        • 签发火山引擎 VOD STS Token
      • 数据概览
      • 源类型选项
      • 清理应用缓存
      • 获取前端路由配置
    • 系统管理
      • 角色管理
        • 角色列表
        • 创建角色
        • 角色详情
        • 修改角色
        • 删除角色
        • 获取角色权限
        • 权限列表
        • 更新角色权限
      • 管理员管理
        • 导出审计日志
        • 获取个人资料
        • 修改密码
        • 更新个人资料
        • 管理员列表
        • 创建管理员
        • 管理员详情
        • 修改管理员
        • 删除管理员
        • 修改密码
        • 设置状态
        • 管理员角色
        • 分配管理员角色
        • 管理员登录历史
        • 修改管理员头像
      • 菜单管理
        • 菜单树
        • 创建菜单
        • 菜单详情
        • 更新菜单
        • 删除菜单
      • 配置管理
        • 配置分组
        • 输入组件类型
        • 批量更新配置
        • 配置列表
        • 创建配置
        • 配置详情
        • 更新配置
        • 删除配置
      • 地区管理
        • 地区列表
        • 创建地区
        • 地区详情
        • 更新地区
        • 删除地区
      • 验证码管理
        • 手机验证码列表
        • 手机验证码详情
        • 邮件验证码列表
        • 邮件验证码详情
      • 附件管理
        • 获取附件列表
        • 直传完成后登记附件元数据
        • 获取附件详情
        • 删除单个附件
        • 流式下载附件
        • 批量删除附件
        • 获取附件临时签名访问地址
        • 重命名附件
        • 移动附件物理路径
        • 可用磁盘列表
      • 通知管理
        • 通知列表
        • 未读通知列表
        • 全部标记已读
        • 标记通知已读
        • 清空已读通知
      • 字典管理
        • 按编码获取字典项
        • 字典类型列表(分页)
        • 创建字典类型
        • 字典类型详情
        • 更新字典类型
        • 删除字典类型
        • 字典数据项列表(分页)
        • 创建字典数据项
        • 字典数据项详情
        • 更新字典数据项
        • 删除字典数据项
      • 应用管理
        • 删除应用
        • 删除版本
        • 应用列表
        • 应用详情
        • 版本列表
        • 版本详情
        • 创建应用
        • 创建版本
        • 废弃版本
        • 发布版本
        • 撤回版本
        • 更新应用
        • 更新版本
    • 系统监控
      • 性能监控(Pulse)
        • 服务器资源监控
        • 队列监控
        • Reverb连接监控
        • Reverb消息监控
        • 缓存命中率监控
        • 异常统计监控
        • 慢查询监控
        • 慢请求监控
        • 慢任务监控
        • 慢外部请求监控
        • 用户使用量统计
      • 调试工具(Telescope)
        • 调试条目列表
        • 调试条目详情
        • 标记异常为已解决
        • 监控标签列表
        • 添加监控标签
        • 移除监控标签
        • 切换记录开关
        • 清空调试记录
      • 队列管理(Horizon)
        • 取消监控标签
        • 批处理列表
        • 批处理详情
        • 已完成任务
        • 失败任务列表
        • 失败任务详情
        • 最近任务详情
        • 待处理任务
        • 静默任务
        • 主监督器
        • 任务指标列表
        • 任务指标详情
        • 队列指标列表
        • 队列指标详情
        • 标签下任务
        • 监控标签列表
        • 队列总览
        • 队列负载
        • 重试批处理失败任务
        • 重试失败任务
        • 新增监控标签
      • 调度任务日志
        • 获取调度任务日志列表
        • 获取调度任务日志详情
      • 登录日志
        • 获取全局登录历史列表
      • 审计日志
        • 审计日志列表
        • 审计日志详情
    • 用户管理
      • 用户管理
        • 回收站用户列表
        • 恢复软删除用户
        • 彻底删除用户
        • 导出用户列表
        • 导出用户积分流水
        • 导出用户金币流水
        • 用户金币流水
        • 用户积分流水
        • 用户社交账号
        • 用户钱包概览
        • 用户钱包流水
        • 调整用户余额
        • 用户列表
        • 用户详情
        • 更新用户信息
        • 删除用户
        • 冻结/启用用户
        • 重置用户密码
        • 重置用户联系方式
        • 调整用户余额
        • 延长用户VIP
        • 用户登录历史
      • 邀请记录
        • 获取邀请记录列表
        • 获取邀请记录详情
      • 实名认证
        • 实名认证列表
        • 实名认证统计
        • 实名认证详情
        • 审核通过
        • 审核驳回
      • 用户分群
        • 分群管理
          • 分群列表
          • 创建分群
          • 分群详情
          • 更新分群
          • 删除分群
          • 切换启用/禁用状态
          • 手动同步规则分群
          • 规则预览(不写库)
          • 分群下拉选项
        • 分群成员
          • 分群下的用户列表
          • 单分群批量绑定用户
          • 单分群批量解绑用户
          • 笛卡尔批量打标
          • 笛卡尔批量解标
        • 分群任务
          • 分群异步任务列表
          • 分群异步任务详情
    • 运营管理
      • 公告管理
        • 公告列表
        • 创建公告
        • 公告详情
        • 更新公告
        • 切换公告状态
        • 删除公告
      • 轮播图管理
        • 创建 Banner
        • 删除 Banner
        • Banner 详情
        • Banner 列表
        • Banner 拖拽排序
        • 切换 Banner 状态
        • 更新 Banner
        • 展示位置选项
      • 反馈管理
        • 导出反馈列表
        • 反馈统计数据
        • 反馈列表
        • 反馈详情
        • 更新反馈(处理反馈)
        • 更新反馈(处理反馈)- PATCH
        • 删除反馈
      • 评论管理
        • 评论列表
        • 评论详情
        • 评论回复列表
        • 审核评论
        • 删除评论
        • 导出评论列表
      • 任务管理
        • 任务分组
          • 切换分组启用状态
          • 删除任务分组
          • 更新任务分组
          • 任务分组详情
          • 任务分组选项
          • 创建任务分组
          • 任务分组列表
        • 任务管理
          • 任务记录
            • 任务日志列表
            • 任务日志详情
          • 任务列表
          • 创建任务
          • 任务详情
          • 更新任务
          • 删除任务
          • 切换任务启用状态
      • 钱包管理
        • 钱包统计
        • 充值订单列表
        • 导出充值订单
        • 充值订单详情
        • 充值统计
        • 钱包流水列表
        • 导出钱包流水
        • 钱包流水详情
        • 提现申请列表
        • 导出提现申请
        • 提现统计
        • 提现申请详情
        • 关闭充值订单
        • 确认到账
        • 审核通过
        • 标记打款失败
        • 审核驳回
        • 标记打款
      • 敏感词管理
        • 获取分类与级别选项
        • 敏感词列表
        • 创建敏感词
        • 批量导入敏感词
        • 手动刷新字典缓存
        • 敏感词详情
        • 更新敏感词
        • 删除敏感词
        • 切换启用状态
      • 举报管理
        • 举报列表
        • 举报详情
        • 处理举报
        • 举报统计
        • 举报列表导出
    • AI 助手
      • AI聊天
        • 工具调用审批
        • 发送消息(同步)
        • 获取会话列表
        • 获取会话详情与消息记录
        • 删除会话
    • 定时任务管理
      • 定时任务列表
      • 创建定时任务
      • 获取可用命令列表
      • 定时任务详情
      • 更新定时任务
      • 删除定时任务
      • 切换启用/禁用状态
      • 手动执行定时任务
  1. Admin

后台API接口使用说明

概述#

本文档描述后台管理系统 API 的使用方式,包括请求格式、认证方式、分页规范、状态码和数据模型等。
基础 URL: /admin/
数据格式: JSON
字符编码: UTF-8
认证方式: Bearer Token (Laravel Sanctum)

基本使用#

后台 API 以 admin 为前缀。
有效的 API 请求示例:

请求头#

Header必填说明
Accept是必须为 application/json
Authorization是*Bearer {token},登录接口不需要
Content-Type是*application/json,POST/PUT 请求需要
User-Agent否建议传递,标识调用方

认证#

登录获取令牌#

调用 账号密码登录 接口,使用用户名和密码换取访问令牌。
响应中返回 access_token 字段和 user 信息(引用 LoginInfo 模型)。

使用令牌#

在后续请求的 Header 中携带令牌:
Authorization: Bearer {access_token}

退出登录#

调用 退出登录 接口,使当前令牌失效。

状态码#

API 根据请求类型和操作结果返回不同的 HTTP 状态码。

请求类型与状态码#

请求类型描述
GET访问一个或多个资源,返回 200 OK
POST创建资源成功返回 201 Created,响应体包含新资源
PUT / PATCH更新资源成功返回 200 OK,响应体包含更新后资源
DELETE删除资源成功返回 204 No Content,无响应体

通用状态码#

状态码描述
200OK。请求成功。
201Created。资源创建成功。
204No Content。请求成功,无响应体(如 DELETE)。
304Not Modified。资源未修改,可使用缓存。
400Bad Request。请求参数无效。
401Unauthorized。未认证或令牌无效。
403Forbidden。已认证但无权限访问。
404Not Found。请求的资源不存在。
405Method Not Allowed。HTTP 方法不被允许。
415Unsupported Media Type。不支持的媒体类型。
422Unprocessable Entity。数据验证失败,详见响应体。
429Too Many Requests。请求过于频繁,触发限流。
500Internal Server Error。服务器内部错误。

验证错误响应 (422)#

当请求数据验证失败时,返回 422 状态码,响应体包含 message 和 errors:
{
  "message": "The given data was invalid.",
  "errors": {
    "username": ["用户名字段必填"],
    "email": ["邮箱格式不正确"]
  }
}

分页#

列表接口默认支持分页,使用 Eloquent 分页结构(EloquentPaginate 模型)。

请求参数#

参数类型默认值描述
pageinteger1页码
per_pageinteger15每页条数,最大 100
示例:

响应结构#

分页响应包含三个顶层字段:data、links、meta。
{
  "data": [
    {
      "id": 1,
      "name": "管理员"
    }
  ],
  "links": {
    "first": "http://app.com/admin/admins?page=1",
    "last": "http://app.com/admin/admins?page=10",
    "prev": "http://app.com/admin/admins?page=1",
    "next": "http://app.com/admin/admins?page=3"
  },
  "meta": {
    "current_page": 2,
    "from": 16,
    "last_page": 10,
    "path": "http://app.com/admin/admins",
    "per_page": 15,
    "to": 30,
    "total": 150
  }
}

字段说明#

data: 当前页数据数组,元素为对应业务模型
links: 分页导航链接(首页、末页、上一页、下一页)
meta: 分页元信息(当前页、总页数、总数等)

数据模型#

API 响应数据均复用标准数据模型,以下为常用模型一览:

通用模型#

模型名显示名描述
EloquentPaginate集合分页Eloquent 标准分页结构
SimplePaginate简单分页简单分页(只有上一页/下一页)
CursorPaginate游标分页基于游标的分页结构
Status状态通用状态枚举 { value, label }
Gender性别性别枚举 { value, label }
LoginInfo登录信息当前登录用户信息
LoginToken登录授权登录返回的令牌结构

业务模型#

模型名显示名描述
Admin管理员管理员账号信息
Role角色信息角色数据
Menu菜单菜单项数据
Permission权限权限项数据
Login Histories登录历史登录记录
Notification通知信息通知消息

接口清单#

认证模块#

接口方法路径描述
账号密码登录POST/admin/auth/login使用用户名密码登录
退出登录POST/admin/auth/logout退出当前登录
当前登录信息GET/admin/auth/info获取当前登录用户信息

管理员模块#

接口方法路径描述
管理员列表GET/admin/admins分页获取管理员列表
管理员详情GET/admin/admins/{admin_id}获取单个管理员详情
创建管理员POST/admin/admins创建新管理员
修改管理员PUT/admin/admins/{admin_id}更新管理员信息
删除管理员DELETE/admin/admins/{admin_id}删除管理员
设置状态PUT/admin/admins/{admin_id}/toggle-status切换管理员启用/禁用状态
修改密码PUT/admin/admins/{admin_id}/reset-password重置管理员密码
管理员角色GET/admin/admins/{admin_id}/roles获取管理员的角色列表
分配管理员角色PUT/admin/admins/{admin_id}/roles为管理员分配角色

角色模块#

接口方法路径描述
角色列表GET/admin/roles分页获取角色列表
角色详情GET/admin/roles/{role_id}获取单个角色详情
创建角色POST/admin/roles创建新角色
修改角色PUT/admin/roles/{role_id}更新角色信息
删除角色DELETE/admin/roles/{role_id}删除角色
获取角色权限GET/admin/roles/{role_id}/permissions获取角色的权限列表
更新角色权限PUT/admin/roles/{role_id}/permissions更新角色的权限
权限列表GET/admin/roles/permissions获取所有权限列表(分页)

菜单模块#

接口方法路径描述
菜单列表GET/admin/menus分页获取菜单列表
菜单详情GET/admin/menus/{menu_id}获取单个菜单详情
菜单树GET/admin/menus/tree获取菜单树结构
创建菜单POST/admin/menus创建新菜单
修改菜单PUT/admin/menus/{menu_id}更新菜单信息
删除菜单DELETE/admin/menus/{menu_id}删除菜单

错误处理#

认证错误 (401)#

{
  "message": "Unauthenticated."
}

权限错误 (403)#

{
  "message": "This action is unauthorized."
}

资源不存在 (404)#

{
  "message": "No query results for model [App\\Models\\Admin] 999"
}

其他说明#

时间格式#

所有时间字段均使用 ISO 8601 格式(Y-m-d H:i:s),例如:2024-01-15 10:30:00。

区间查询#

区间查询遵循左闭右开原则,即开始值包含在区间内,结束值不包含在区间内。若开始值和结束值相同,则为无效区间。

未知路由#

访问不存在的 API 路径将返回 404 Not Found。

限流#

API 启用了速率限制,默认为每分钟 60 次请求。超出限制将返回 429 Too Many Requests。
修改于 2026-08-15 08:14:41
下一页
认证授权说明
Built with