Stooland Docs

Appearance

API 文档入口 ​

本目录收录后端接口文档与规范：

  • 详尽模块说明参见：./openapi.yaml
  • 迁移自 api/README.md 的文字版接口说明如下（建议逐步统一到 OpenAPI）：

SmartEnlightenmentToolset API 文档 ​

项目介绍 ​

斯图兰API框架（SmartEnlightenmentToolset API Framework）是一个基于ThinkPHP 8开发的多功能API服务框架，提供了管理后台、用户服务、内容管理、AI能力集成等多种功能模块。

API接口文档 ​

一、admin模块 ​

管理后台相关API接口

角色管理 ​

  • GET|POST|PATCH|DELETE /admin/role - 角色资源管理（增删改查）

权限管理 ​

  • GET|POST|PATCH|DELETE /admin/access - 权限资源管理（增删改查）

用户管理 ​

  • GET /admin/user/record - 获取备案人员
  • POST /admin/user/import - 导入备案人员
  • GET|POST|PATCH|DELETE /admin/user - 用户资源管理（增删改查）

菜单管理 ​

  • GET|POST|PATCH|DELETE /admin/menu - 菜单资源管理（增删改查）

审计管理 ​

  • GET|POST|PATCH|DELETE /admin/audit - 审计记录管理（增删改查）

预警管理 ​

  • GET|POST|PATCH|DELETE /admin/warning - 预警记录管理（增删改查）

统计分析 ​

  • POST /admin/statistics/user/pie - 用户统计饼图数据
  • POST /admin/statistics/passport/pie - 证照统计饼图数据
  • POST /admin/statistics/travel/pie - 出行统计饼图数据
  • POST /admin/statistics/application/pie - 申请统计饼图数据
  • POST /admin/statistics/application/year - 申请统计年度柱状图数据
  • POST /admin/statistics/warning/pie - 预警统计嵌套饼图数据
  • POST /admin/statistics/warning/year - 预警统计年度堆叠柱状图数据

阿里云服务 ​

获取OSS直传URL ​
  • POST /admin/ali/oss/getDirectUploadUrl - 获取OSS直传预签名数据
    • 输入参数：
      • bucket：存储空间名称（必填）
      • region：区域（选填，默认cn-shenzhen）
      • upload_dir：上传文件前缀（选填，默认'user-dir'）
      • expires：过期时间（选填，默认3600秒）
    • 返回参数：
      • 成功：{"timestamp": 时间戳, "returnCode": 0, "message": "获取OSS直传URL成功", "responseData": {"policy": "Base64编码的Policy", "x_oss_signature_version": "OSS4-HMAC-SHA256", "x_oss_credential": "访问凭证", "x_oss_date": "日期时间", "signature": "签名", "host": "OSS Bucket域名", "dir": "上传目录", "security_token": "安全令牌", "access_key_id": "临时访问密钥ID", "expire": "过期时间戳"}}
      • 失败：{"timestamp": 时间戳, "returnCode": 1003, "message": "参数错误"} 或 {"timestamp": 时间戳, "returnCode": 1000, "message": "获取OSS直传URL失败：错误信息"}

二、agent模块 ​

代理服务相关API接口

API代理 ​

  • GET|POST|PATCH|DELETE /agent/api - API代理资源管理
  • GET|POST|PATCH|DELETE /agent/api/coze - Coze API代理资源管理
  • GET|POST|PATCH|DELETE /agent/api/coze/chat - Coze聊天代理资源管理
  • GET|POST|PATCH|DELETE /agent/api/coze/message - Coze消息代理资源管理

管理端代理 ​

  • GET|POST|PATCH|DELETE /agent/admin - 管理端代理资源管理
  • POST /agent/admin/stream/connect - WebRTC连接
  • POST /agent/admin/stream/message - 发送用户消息
  • GET /agent/admin/stream/chat/create/:agent_id - 刷新聊天

三、aigc模块 ​

AI内容生成相关API接口

管理端AIGC功能 ​

  • GET|POST|PATCH|DELETE /aigc/admin/storyboard - 故事板资源管理
  • GET|POST|PUT|DELETE /aigc/admin/formula - AIGC公式资源管理
  • POST /aigc/admin/volcengine/ark - 火山引擎ARK服务调用
  • GET /aigc/admin/ali/sts - 获取阿里云STS Token
  • GET|POST|PATCH|DELETE /aigc/admin/ali/ice - 阿里云ICE服务资源管理
  • POST /aigc/admin/ali/ice/uploadMediaByUrl - 通过URL上传媒体
  • POST /aigc/admin/ali/ice/getUrlUploadInfos - 获取URL上传信息
  • POST /aigc/admin/ali/ice/createEditingProject - 创建编辑项目
  • POST /aigc/admin/ali/ice/getEditingProject - 获取编辑项目
  • POST /aigc/admin/ali/ice/submitMediaProducing - 提交媒体制作任务
  • POST /aigc/admin/ali/ice/getMediaProducingJob - 获取媒体制作任务状态
  • POST /aigc/admin/ali/ice/getPresignUrl - 获取预签名URL
  • GET /aigc/admin/ali/ice/getStsToken - 获取OSS STS Token
  • POST /aigc/admin/ali/ice/getDirectUploadUrl - 获取直接上传URL

四、article模块 ​

文章内容相关API接口

应用端文章功能 ​

  • GET /article/app/slideshow - 获取幻灯片文章
  • GET /article/app/article_unread - 获取未读文章
  • GET|POST|PATCH|DELETE /article/app/article - 文章资源管理
  • GET|POST|PATCH|DELETE /article/app/article/type - 文章类型资源管理

管理端文章功能 ​

  • GET|POST|PATCH|DELETE /article/admin/article - 管理端文章资源管理
  • GET|POST|PATCH|DELETE /article/admin/article/type - 管理端文章类型资源管理

五、auth模块 ​

认证授权相关API接口

应用端登录认证 ​

  • POST /auth/app/login/uni - 统一登录
  • POST /auth/app/login/check - 检查Token有效性
  • POST /auth/app/login/mobile - 手机号登录
  • POST /auth/app/login/mobile_verify - 手机号验证码登录
  • POST /auth/app/login/account - 账号密码登录
  • GET /auth/app/logout - 退出登录
  • GET /auth/app/check/login - 检查登录状态
  • POST /auth/app/wx/official - 微信公众号登录
  • POST /auth/app/wx/mp - 微信小程序登录
  • POST /auth/app/password/reset - 重置密码

商户端登录认证 ​

  • POST /auth/merchant/login/mobile - 商户手机号登录
  • POST /auth/merchant/login/mobile_verify - 商户手机号验证码登录
  • POST /auth/merchant/wx/mp - 商户微信小程序登录
  • GET /auth/merchant/logout - 商户退出登录
  • POST /auth/merchant/password/reset - 商户重置密码

管理端登录认证 ​

  • POST /auth/admin/login - 管理员登录
  • GET /auth/admin/logout - 管理员退出登录
  • GET|POST|PATCH|DELETE /auth/admin/member - 管理端会员资源管理

六、dataShare模块 ​

数据共享相关API接口

管理端数据共享 ​

  • GET|POST|PATCH|DELETE /dataShare/admin/billboard - 公告板资源管理

七、index模块 ​

首页相关API接口

  • GET /index/ - 系统首页

八、material模块 ​

素材管理相关API接口

API端素材功能 ​

  • GET|POST|PATCH|DELETE /material/api/image - 图片资源管理
  • GET|POST|PATCH|DELETE /material/api/image/type - 图片类型资源管理
  • GET /material/api/image/topic/hot - 获取热门图片主题
  • GET|POST|PATCH|DELETE /material/api/image/topic - 图片主题资源管理
  • GET|POST|PATCH|DELETE /material/api/image/creation - 图片创作资源管理
  • GET|POST|PATCH|DELETE /material/api/image/download - 图片下载资源管理

管理端素材功能 ​

  • GET /material/admin/image/fetch/local - 本地抓取图片
  • GET|POST|PATCH|DELETE /material/admin/image - 管理端图片资源管理
  • GET|POST|PATCH|DELETE /material/admin/image/type - 管理端图片类型资源管理
  • GET|POST|PATCH|DELETE /material/admin/image/topic - 管理端图片主题资源管理
  • GET|POST|PATCH|DELETE /material/admin/image/creation - 管理端图片创作资源管理
  • GET /material/admin/image/getRandomVideoByTopic/:id - 根据主题获取随机视频
  • GET /material/admin/image/qiniu/stat/:id - 检查图片七牛状态
  • GET /material/admin/image/qiniu/stat/batch - 批量检查图片七牛状态
  • GET /material/admin/image/qiniu/censor/:id - 检查文件审核状态
  • GET /material/admin/image/qiniu/censor/batch - 批量检查文件审核状态
  • GET /material/admin/image/file/info/batch - 批量获取图片信息
  • GET /material/admin/image/pfop/batch - 批量处理图片
  • GET /material/admin/image/douyin/censor/:id - 抖音图片审核
  • GET /material/admin/image/topic/cover - 随机主题封面
  • POST /material/admin/image/batch - 图片批量操作
  • GET /material/admin/image/batch/download - 批量下载图片

九、member模块 ​

会员管理相关API接口

应用端会员功能 ​

  • GET /member/app/detail - 获取会员详情
  • GET /member/app/merchant_detail - 获取商户详情
  • POST /member/app/update - 更新会员信息
  • GET|POST|PATCH|DELETE /member/app/real - 会员实名认证资源管理
  • GET|POST|PATCH|DELETE /member/app/address - 会员地址资源管理
  • GET /member/app/service_code - 获取服务代码
  • GET /member/app/service_list - 获取服务列表
  • GET /member/app/service_record - 获取服务记录

管理端会员功能 ​

  • POST /member/admin/member/batch/status - 批量更新会员状态
  • GET /member/admin/member/export - 导出会员数据
  • POST /member/admin/member/import - 导入会员数据
  • GET|POST|PATCH|DELETE /member/admin/member - 管理端会员资源管理
  • GET|POST|PATCH|DELETE /member/admin/real - 管理端实名认证资源管理
  • POST /member/admin/service_record/import - 导入服务记录
  • GET /member/admin/service_record/export - 导出服务记录
  • GET|POST|PATCH|DELETE /member/admin/service_record - 管理端服务记录资源管理
  • GET|POST|PATCH|DELETE /member/admin/member_service - 管理端会员服务资源管理

十、message模块 ​

消息管理相关API接口

管理端消息功能 ​

  • GET|POST|PATCH|DELETE /message/admin/user - 管理端用户消息资源管理

十一、mission模块 ​

任务管理相关API接口

API端任务功能 ​

  • GET|POST|PATCH|DELETE /mission/api/mission - 任务资源管理
  • GET|POST|PATCH|DELETE /mission/api/result - 任务结果资源管理
  • GET /mission/api/runAIMissionMethod - 运行AI任务方法
  • GET /mission/api/qiniuAsyncFetchCallback - 七牛异步抓取回调
  • GET /mission/api/runQiniuFetchRun - 运行七牛抓取任务

管理端任务功能 ​

  • GET|POST|PATCH|DELETE /mission/admin - 管理端任务资源管理
  • GET|POST|PATCH|DELETE /mission/admin/result - 管理端任务结果资源管理
  • GET /mission/admin/runText2Image/:id - 运行文本到图像任务

十二、common模块 ​

公共服务相关API接口

阿里云OSS服务 ​

创建文件夹 ​
  • POST /common/aliyun-oss/create-folder - 创建文件夹
    • 输入参数：
      • bucket：存储空间名称（必填）
      • folder_name：文件夹名称（必填）
      • region：区域（选填，默认cn-shenzhen）
    • 返回参数：
      • 成功：{"timestamp": 时间戳, "returnCode": 0, "message": "文件夹创建成功", "responseData": {"folder_name": "创建的文件夹名称"}}
      • 失败：{"timestamp": 时间戳, "returnCode": 2000, "message": "创建文件夹失败：错误信息"}
上传文件 ​
  • POST /common/aliyun-oss/upload-file - 上传文件
    • 输入参数：
      • bucket：存储空间名称（必填）
      • object_key：对象键（必填）
      • file_content：文件内容（可选，与file二选一）
      • file：文件上传（可选，与file_content二选一）
      • region：区域（选填，默认cn-shenzhen）
    • 返回参数：
      • 成功：{"timestamp": 时间戳, "returnCode": 0, "message": "文件上传成功", "responseData": {"object_key": "上传的对象键"}}
      • 失败：{"timestamp": 时间戳, "returnCode": 2000, "message": "文件上传失败：错误信息"}
删除文件 ​
  • DELETE /common/aliyun-oss/delete-file - 删除文件
    • 输入参数：
      • bucket：存储空间名称（必填）
      • object_key：对象键（必填）
      • region：区域（选填，默认cn-shenzhen）
    • 返回参数：
      • 成功：{"timestamp": 时间戳, "returnCode": 0, "message": "文件删除成功", "responseData": {"object_key": "删除的对象键"}}
      • 失败：{"timestamp": 时间戳, "returnCode": 2000, "message": "文件删除失败：错误信息"}
获取文件列表 ​
  • GET /common/aliyun-oss/list-files - 获取文件列表（包含文件和文件夹）