三、API 部分接口分类详解

以下是 AnQiCMS 提供的 API 接口分类,以及部分接口参数,更多的文档接口以及参数配置,请参考详细文档。

3.1 内容管理接口

内容管理接口用于处理网站的核心内容,包括文档、分类、标签等。

3.1.1 获取文档详情接口

  • 接口路径/api/archive/detail
  • 请求方式:GET
  • 功能:获取单个文档详细信息
  • 参数
    • id (int, 必填) - 文档ID
    • filename (string, 可选) - 文档URL别名(id/filename 二选一)
    • render (boolean, 可选) - 是否渲染内容成HTML(Markdown文档渲染),默认为true

3.1.2 获取文档列表接口

  • 接口路径/api/archive/list
  • 请求方式:GET
  • 功能:获取文档列表
  • 参数
    • moduleId (int, 可选) - 模型ID
    • categoryId (string, 可选) - 分类ID,多个可用逗号分隔
    • limit (int, 可选) - 显示数量
    • page (int, 可选) - 页码
    • order (string, 可选) - 排序方式,如 id desc

3.1.3 获取文档参数接口

  • 接口路径/api/archive/params
  • 请求方式:GET
  • 功能:获取文档自定义参数
  • 参数
    • id (int, 必填) - 文档ID
    • filename (string, 可选) - 文档URL别名(id/filename 二选一)
    • sorted (int, 可选) - 返回格式,true为数组格式,false为对象格式

3.1.4 获取分类详情接口

  • 接口路径/api/category/detail
  • 请求方式:GET
  • 功能:获取分类详细信息
  • 参数
    • id (int, 可选) - 分类ID
    • filename (string, 可选) - 分类URL别名

3.1.5 获取分类列表接口

  • 接口路径/api/category/list
  • 请求方式:GET
  • 功能:获取分类列表
  • 参数
    • moduleId (int, 可选) - 模型ID
    • parentId (int, 可选) - 上级分类ID
    • limit (int, 可选) - 显示数量

3.1.6 获取标签列表接口

  • 接口路径/api/tag/list
  • 请求方式:GET
  • 功能:获取标签列表
  • 参数
    • itemId (int, 可选) - 文档ID
    • letter (string, 可选) - 首字母筛选
    • type (string, 可选) - 返回类型

3.2 用户管理接口

用户管理接口用于处理用户注册、登录、信息管理等功能。

3.2.1 用户登录接口

  • 接口路径/api/login
  • 请求方式:POST
  • 功能:用户登录认证
  • 参数
    • user_name (string, 可选) - 用户名
    • password (string, 可选) - 密码
    • email (string, 可选) - 邮箱
    • phone (string, 可选) - 手机号

3.2.2 用户注册接口

  • 接口路径/api/register
  • 请求方式:POST
  • 功能:新用户注册
  • 参数
    • user_name (string, 可选) - 用户名
    • password (string, 可选) - 密码
    • email (string, 可选) - 邮箱
    • phone (string, 可选) - 手机号
    • captcha (string, 可选) - 验证码

3.2.3 获取用户详情接口

  • 接口路径/api/user/detail
  • 请求方式:GET
  • 功能:获取用户详细信息
  • 需要认证:是

3.2.4 用户收藏管理

  • 获取收藏列表/api/favorite/list
  • 添加收藏/api/favorite/add
  • 检查收藏状态/api/favorite/check
  • 移除收藏/api/favorite/delete

3.3 评论互动接口

评论互动接口用于处理用户评论和互动功能。

3.3.1 获取评论列表接口

  • 接口路径/api/comment/list
  • 请求方式:GET
  • 功能:获取评论列表
  • 参数
    • archive_id (int, 可选) - 文档ID
    • parent_id (int, 可选) - 父评论ID
    • limit (int, 可选) - 显示数量

3.3.2 发布评论接口

  • 接口路径/api/comment/publish
  • 请求方式:POST
  • 功能:发布评论
  • 需要认证:是
  • 参数
    • archive_id (int, 必填) - 文档ID
    • content (string, 必填) - 评论内容
    • parent_id (int, 可选) - 父评论ID

3.4 购物车与订单接口

购物车与订单接口用于处理商品购买流程。

3.4.1 购物车管理

  • 添加购物车/api/cart/add
  • 获取购物车列表/api/cart/list
  • 更新购物车/api/cart/update
  • 移除购物车/api/cart/remove

3.4.2 订单管理

  • 创建订单/api/order/create
  • 获取订单详情/api/order/detail
  • 获取订单列表/api/orders
  • 取消订单/api/order/cancel
  • 完成订单/api/order/finished
  • 订单支付/api/order/payment

3.5 评价与优惠券接口

3.5.1 评价管理

  • 发布订单评价/api/review/publish
  • 获取订单评价/api/review/list

3.5.2 优惠券管理

  • 获取优惠券码/api/coupon/code
  • 获取优惠券列表/api//coupon/codes
  • 获取有效优惠券列表/api/coupon/valid

3.6 分销接口

分销接口用于处理分销员相关功能。

3.6.1 分销员管理

  • 获取分销员详情/api/retailer/info
  • 更新分销员信息/api/retailer/update
  • 获取分销员统计/api/retailer/statistics

3.6.2 分销收益管理

  • 获取分销员收益列表/api/retailer/commissions
  • 获取分销团队列表/api/retailer/members
  • 获取分销员订单/api/retailer/orders

3.6.3 分销提现管理

  • 申请分销员提现/api/retailer/withdraw
  • 获取分销员提现记录/api/retailer/withdraw

3.7 系统与配置接口

系统与配置接口用于获取系统设置和配置信息。

3.7.1 系统设置

  • 获取系统设置/api/setting/system
  • 获取联系信息/api/setting/contact
  • 获取首页设置/api/setting/index
  • 获取自定义字段/api/setting/diy

3.7.2 其他系统接口

  • 获取多语言站点/api/languages
  • 获取Google URL/api/google/url
  • 统计数据/api/log

3.8 留言与验证接口

3.8.1 留言管理

  • 提交留言/api/guestbook.html
  • 获取留言字段/api/guestbook/fields

3.8.2 验证管理

  • 获取验证码/api/captcha
  • 发送邮箱验证/api/verify/email
  • 验证邮箱/api/verify/email

3.9 上传接口

  • 上传附件接口/api/attachment/upload
  • 请求方式:POST
  • 功能:上传文件附件

3.10 文档导入接口

文档导入接口用于从第三方平台导入内容。

  • 导入文档/api/import/archive
  • 检查文档是否存在/api/import/archive/check
  • 获取文档分类列表/api/import/categories
  • 添加友情链接/api/friendlink/create
  • 检查链接是否存在/api/friendlink/check
  • 删除链接/api/friendlink/delete
  • 生成站点地图/api/import/sitemap

3.11 微信相关接口

  • 微信接口/api/wechat
  • 微信授权接口/api/wechat/auth
  • 获取小程序二维码/api/weapp/qrcode

3.12 其他接口

  • 订阅接口/api/subscription
  • 支付检查接口/api/payment/check