文档接口

AnqiCMS文档API接口支持调用的有：导入文档接口、获取文档列表接口、获取文档详情接口、获取上一个文档接口、获取下一个文档接口、获取文档参数筛选条件接口、获取文档参数接口

• 获取文档列表接口

  获取系统中指定条件的文档列表，支持多种筛选和排序方式，可以获取指定模型、分类、推荐属性等条件下的文档列表。此接口同时适用于文档和产品类型的内容。 注意事项 接口支持多种类型的数据获取（page、list、related），不同类型的参数效果可能不同 当 type=“page” 时，支持分页功能和搜索功能 支持自定义筛选参数，可根据模型中配置的字段进行筛选 部分字段如价格

• 获取产品/文档详情接口

  获取AnQiCMS 系统中单个文档的详细信息，包括文档的基本信息、分类信息、内容详情及其他自定义字段信息。此接口同时适用于文档和产品类型的内容。 注意事项 接口支持通过文档 ID 或 URL 别名（filename）两种方式获取文档详情 可通过本接口获取上一篇、下一篇文档 部分字段如价格、库存、SKU 等仅在产品类型文档中有效 响应中包含 SEO 相关字段，便于 SEO 优化 如果文档不存在

• 获取上一个文档接口

  获取指定文档的上一个文档信息，通常用于文档详情页的上下篇导航功能。如果指定文档是第一个文档，则返回空结果。 注意事项 接口按照文档 ID 顺序查找上一个文档 当指定文档为第一个文档时，返回的 data 为 null 仅返回文档的基本信息，不包含文档内容详情 接口会返回同分类下的上一个文档 请求地址 {域名地址}/api/archive/prev 说明：{域名地址} 需要替换成你的域名地址，如

• 获取下一个文档接口

  获取指定文档的下一个文档信息，通常用于文档详情页的上下篇导航功能。如果指定文档是最后一个文档，则返回空结果。 注意事项 接口按照文档 ID 顺序查找下一个文档 当指定文档为最后一个文档时，返回的 data 为 null 仅返回文档的基本信息，不包含文档内容详情 接口会返回同分类下的下一个文档 请求地址 {域名地址}/api/archive/next 说明：{域名地址} 需要替换成你的域名地址

• 获取文档参数筛选条件接口

  获取指定模型的文档参数筛选条件，返回模型中可用于筛选的字段及其可选项，适用于构建文档筛选功能的前端界面。 注意事项 接口需要指定模型 ID，以便获取对应模型的筛选条件 返回的筛选条件基于模型中设置的字段类型 筛选项包含总数统计，便于用户了解各选项下的文档数量 请求地址 {域名地址}/api/archive/filters 说明：{域名地址} 需要替换成你的域名地址，如 https://www

• 获取文档参数接口

  获取指定文档的自定义参数信息，支持按排序数组或无序 map 对象两种格式返回，用于获取文档模型中设置的额外字段信息。 注意事项 接口支持通过文档 ID 获取特定文档的参数 通过 sorted 参数控制返回格式：数组格式或对象格式 参数值以换行符分隔多个选项时，表示该字段为多选项类型 请求地址 {域名地址}/api/archive/params 说明：{域名地址} 需要替换成你的域名地址，如

• 文档发布接口

  API 调用地址 {域名地址}/api/archive/publish 说明：{域名地址} 需要替换成你的域名地址，如 /api/archive/publish 调用方法 POST application/json 请求参数 字段名 类型 必填 说明 title string 是 文档标题 cont

• 检查指定文档是否支付了接口

  检查当前登录用户是否已购买或支付指定的文档内容，用于验证用户对付费文档的访问权限。 注意事项 此接口需要用户已登录，否则会返回未登录错误 仅适用于设置了付费访问的文档 接口返回布尔值，表示当前用户是否已支付该文档 未登录用户调用此接口会返回错误码 1001 请求地址 {域名地址}/api/archive/order/check 说明：{域名地址} 需要替换成你的域名地址，如 https

• 验证文档密码接口

  验证访问受密码保护文档的密码是否正确，用于保护需要密码访问的文档内容。验证成功后返回文档内容，验证失败则返回错误信息。 注意事项 此接口使用 POST 方法提交验证请求 接口需要同时提供文档 ID 和密码进行验证 验证成功后会返回文档内容，验证失败则返回错误信息 仅适用于设置了密码保护的文档 请求地址 {域名地址}/api/archive/password/check 说明：{域名地址}

• 获取收藏列表接口

  获取当前用户的收藏列表，支持分页查询，返回用户收藏的所有商品或文档信息。 注意事项 该接口采用GET方法，参数通过URL查询字符串传递 支持分页查询，可指定当前页码和每页显示数量 仅返回当前用户的收藏记录 返回完整的文档信息，包括标题、描述、图片等详细内容 支持获取收藏商品的价格和库存信息 请求地址 {域名地址}/api/favorite/list 说明：{域名地址} 需要替换成你的域名地址

• 添加收藏接口

  将指定商品添加到用户收藏列表中，支持指定商品 SKU，适用于电商功能中的收藏操作。 注意事项 该接口采用POST方法，需要以application/json格式提交数据 需要用户登录后才能操作 必须指定商品 ID 可以通过 SKU ID 指定具体的商品规格 如果商品已经收藏，则会返回相应的提示信息 请求地址 {域名地址}/api/favorite/add 说明：{域名地址}

• 移除收藏接口

  移除指定商品或文档的收藏记录，支持从用户的收藏列表中删除特定项目。 注意事项 该接口采用POST方法，需要以application/json格式提交数据 需要提供文档 ID 以指定要移除的收藏项 仅支持已登录用户移除自己的收藏记录 如果指定的文档未被收藏，则返回成功状态 成功移除后将不再出现在用户的收藏列表中 请求地址 {域名地址}/api/favorite/delete 说明：{域名地址}

• 检查是否收藏接口

  检查指定商品或文档是否已被当前用户收藏，支持单个或批量查询收藏状态。 注意事项 该接口采用POST方法，需要以application/json格式提交数据 需要提供文档 ID 或文档 ID 数组 仅支持已登录用户查询自己的收藏状态 支持单个文档查询和批量查询 返回的收藏记录包含收藏时间等详细信息 请求地址 {域名地址}/api/favorite/check 说明：{域名地址}

• 获取产品SKU接口

  获取指定产品的SKU（库存量单位）信息，包括产品的规格属性、价格、库存、批发规则等详细信息。此接口适用于需要展示产品详细规格和购买选项的场景。 注意事项 接口支持通过产品 ID 或 URL 别名（filename）两种方式获取产品SKU信息 此接口为产品接口，适用于产品类型文档 返回数据包含产品的完整规格信息和SKU列表 如果产品不存在，接口会返回错误码 请求地址