AnQiCMS 是一个基于 Go 语言开发的开源内容管理系统，提供了完整的 API 接口供开发者调用。API 采用 RESTful 设计风格，支持 JSON 格式的数据交互。
快速上手：调用第一个API
以获取文章列表为例，介绍一次完整的 API 调用流程。
1. 准备工作
开始前，需了解以下信息：
- API 基础路径：
/api- 所有 API 请求都需要以该路径为前缀 - 认证方式：部分接口需要认证，使用 JWT Token 进行身份验证
- 请求格式：除上传文件外，所有接口均使用 JSON 格式传输数据
- 响应格式：统一使用 JSON 格式返回数据
2. 构造并发送请求
GET /api/archive/list?limit=10&page=1 HTTP/1.1
Host: your-domain.com
Content-Type: application/json
3. 理解响应结果
- 成功响应：请求成功后，服务器会返回 200 状态码，响应体为 JSON 格式。
{
"code": 0,
"msg": "",
"total": 100,
"data": [...]
}
- 错误处理：请求失败时，JSON 响应体中包含错误码和错误信息。
{
"code": -1,
"msg": "API 接口未开放"
}
API 列表
内容管理接口
| 分类 | API 名称 | 描述 |
|---|---|---|
| 内容管理 | 获取文档详情接口 | 获取单个文档详细信息 |
| 内容管理 | 获取文档列表接口 | 获取文档列表 |
| 内容管理 | 获取文档参数接口 | 获取文档自定义参数 |
| 内容管理 | 获取上一篇文档接口 | 获取上一篇文档 |
| 内容管理 | 获取下一篇文档接口 | 获取下一篇文档 |
| 内容管理 | 检查文档密码接口 | 检查文档密码是否正确 |
| 内容管理 | 发布文档接口 | 发布新文档 |
| 内容管理 | 获取文档SKU接口 | 获取文档SKU信息 |
| 内容管理 | 获取分类详情接口 | 获取分类详细信息 |
| 内容管理 | 获取分类列表接口 | 获取分类列表 |
| 内容管理 | 获取标签详情接口 | 获取标签详细信息 |
| 内容管理 | 获取标签列表接口 | 获取标签列表 |
| 内容管理 | 获取标签文档列表接口 | 获取标签下的文档列表 |
| 内容管理 | 获取页面详情接口 | 获取单页面详情 |
| 内容管理 | 获取页面列表接口 | 获取单页面列表 |
| 内容管理 | 获取模块详情接口 | 获取模块详情 |
| 内容管理 | 获取模块列表接口 | 获取模块列表 |
| 内容管理 | 获取导航列表接口 | 获取导航列表 |
| 内容管理 | 获取Banner列表接口 | 获取首页Banner列表 |
| 内容管理 | 获取友情链接列表接口 | 获取友情链接列表 |
用户管理接口
| 分类 | API 名称 | 描述 |
|---|---|---|
| 用户管理 | 用户登录接口 | 用户登录认证 |
| 用户管理 | 用户注册接口 | 新用户注册 |
| 用户管理 | 用户登出接口 | 用户登出 |
| 用户管理 | 获取用户详情接口 | 获取用户详细信息 |
| 用户管理 | 更新用户详情接口 | 更新用户信息 |
| 用户管理 | 更新用户头像接口 | 更新用户头像 |
| 用户管理 | 重置用户密码接口 | 重置用户密码 |
| 用户管理 | 更新用户密码接口 | 更新用户密码 |
| 用户管理 | 获取用户分组列表接口 | 获取用户分组列表 |
| 用户管理 | 获取用户分组详情接口 | 获取用户分组详情 |
| 用户管理 | 获取用户收藏列表接口 | 获取用户收藏列表 |
| 用户管理 | 添加收藏接口 | 添加收藏 |
| 用户管理 | 检查收藏状态接口 | 检查是否已收藏 |
| 用户管理 | 移除收藏接口 | 移除收藏 |
| 用户管理 | 获取用户愿望清单接口 | 获取用户愿望清单 |
| 用户管理 | 添加愿望清单接口 | 添加到愿望清单 |
| 用户管理 | 移除愿望清单接口 | 从愿望清单移除 |
评论互动接口
| 分类 | API 名称 | 描述 |
|---|---|---|
| 评论互动 | 获取评论列表接口 | 获取评论列表 |
| 评论互动 | 发布评论接口 | 发布评论 |
| 评论互动 | 评论点赞接口 | 评论点赞 |
购物车与订单接口
| 分类 | API 名称 | 描述 |
|---|---|---|
| 购物车 | 添加购物车接口 | 添加商品到购物车 |
| 购物车 | 获取购物车列表接口 | 获取购物车列表 |
| 购物车 | 更新购物车接口 | 更新购物车商品数量 |
| 购物车 | 移除购物车接口 | 从购物车移除商品 |
| 订单 | 创建订单接口 | 创建订单 |
| 订单 | 获取订单详情接口 | 获取订单详情 |
| 订单 | 获取订单列表接口 | 获取订单列表 |
| 订单 | 取消订单接口 | 取消订单 |
| 订单 | 完成订单接口 | 完成订单 |
| 订单 | 订单支付接口 | 订单支付 |
| 订单 | 申请退款接口 | 申请订单退款 |
| 订单 | 发布订单评价接口 | 发布订单评价 |
| 订单 | 获取商品结算信息接口 | 获取商品结算信息 |
| 订单 | 获取订单地址接口 | 获取订单地址 |
| 订单 | 保存订单地址接口 | 保存订单地址 |
| 订单 | 获取订单地址列表接口 | 获取订单地址列表 |
评价与优惠券接口
| 分类 | API 名称 | 描述 |
|---|---|---|
| 评价 | 获取订单评价接口 | 获取订单评价 |
| 优惠券 | 获取优惠券码接口 | 获取优惠券码 |
| 优惠券 | 获取优惠券列表接口 | 获取优惠券列表 |
| 优惠券 | 获取有效优惠券列表接口 | 获取有效优惠券列表 |
分销接口
| 分类 | API 名称 | 描述 |
|---|---|---|
| 分销 | 获取分销员详情接口 | 获取分销员详情 |
| 分销 | 获取分销员收益列表接口 | 获取分销员收益列表 |
| 分销 | 获取分销团队列表接口 | 获取分销团队列表 |
| 分销 | 获取分销员订单接口 | 获取分销员订单 |
| 分销 | 获取分销员统计接口 | 获取分销员统计信息 |
| 分销 | 更新分销员信息接口 | 更新分销员信息 |
| 分销 | 申请分销员提现接口 | 申请分销员提现 |
| 分销 | 获取分销员提现记录接口 | 获取分销员提现记录 |
系统与配置接口
| 分类 | API 名称 | 描述 |
|---|---|---|
| 系统配置 | 获取系统设置接口 | 获取系统设置 |
| 系统配置 | 获取联系信息接口 | 获取联系信息 |
| 系统配置 | 获取首页设置接口 | 获取首页设置 |
| 系统配置 | 获取自定义字段接口 | 获取自定义字段 |
| 系统配置 | 获取多语言站点接口 | 获取多语言站点信息 |
| 系统配置 | 获取Google URL接口 | 获取Google URL |
| 系统配置 | 获取统计数据接口 | 获取统计数据 |
留言与验证接口
| 分类 | API 名称 | 描述 |
|---|---|---|
| 留言 | 留言接口 | 提交留言 |
| 留言 | 获取留言字段接口 | 获取留言字段配置 |
| 验证 | 获取验证码接口 | 获取验证码 |
| 验证 | 发送邮箱验证接口 | 发送邮箱验证 |
| 验证 | 验证邮箱接口 | 验证邮箱 |
上传接口
| 分类 | API 名称 | 描述 |
|---|---|---|
| 上传 | 上传附件接口 | 上传附件 |
文档导入接口
| 分类 | API 名称 | 描述 |
|---|---|---|
| 文档导入 | 导入文档接口 | 通过AI写作等第三方平台产生的内容可以通过该接口导入到AnQiCMS中 |
| 文档导入 | 检查文档是否存在接口 | 检查待导入的文档是否已存在于AnQiCMS系统中，避免重复导入相同内容 |
| 文档导入 | 获取文档分类列表接口 | 获取文档分类列表，用于导入文档时选择分类 |
| 文档导入 | 添加友情链接接口 | 添加友情链接，用于导入文档时添加友情链接 |
| 文档导入 | 检查链接是否存在接口 | 检查链接是否已存在 |
| 文档导入 | 删除链接接口 | 删除链接 |
| 文档导入 | 生成站点地图接口 | 生成站点地图 |
微信相关接口
| 分类 | API 名称 | 描述 |
|---|---|---|
| 微信 | 微信接口 | 微信相关功能 |
| 微信 | 微信授权接口 | 微信授权 |
| 微信 | 获取小程序二维码接口 | 获取小程序二维码 |
其他接口
| 分类 | API 名称 | 描述 |
|---|---|---|
| 其他 | 订阅接口 | 订阅功能 |
| 其他 | 支付检查接口 | 支付检查 |
