安企CMS接口帮助

AnqiCMS支持API接口调用数据，支持的调用有：文档接口、文档标签接口、分类页面接口、其他常用接口

• 导入文档接口

  通过API接口批量导入文档内容，支持文档标题、内容、分类、关键词、缩略图等完整信息的导入，可实现内容的批量迁移和发布。 注意事项 该接口采用POST方法，使用form-data格式提交数据 需要在URL中提供有效的token参数进行身份验证 必须提供文档标题、内容和分类ID 支持自定义URL别名、关键词、描述、缩略图等完整文档信息 支持文档组图上传，最多可设置9张图片 可设置文档发布时间

• 获取文档列表接口

  获取系统中指定条件的文档列表，支持多种筛选和排序方式，可以获取指定模型、分类、推荐属性等条件下的文档列表。此接口同时适用于文档和产品类型的内容。 注意事项 接口支持多种类型的数据获取（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 说明：{域名地址} 需要替换成你的域名地址，如

• 获取标签列表接口

  获取网站的标签列表，支持按文档ID获取特定文档的标签、按首字母筛选、分页查询等功能。 注意事项 该接口采用GET方法 可以获取全部标签列表或指定文档的标签 支持按首字母筛选标签 支持分页查询，可以指定每页显示数量和页码 支持不同的返回类型（列表或分页） 返回标签的基本信息和SEO相关信息 请求地址 {域名地址}/api/tag/list 说明：{域名地址} 需要替换成你的域名地址，如

• 获取标签详情接口

  获取指定标签的详细信息，包括标签名称、SEO信息、链接地址等基本信息。 注意事项 该接口采用GET方法 需要提供标签ID或标签URL别名（filename）来指定查询的标签 标签ID和URL别名二选一，如果提供了filename参数，则可以不传ID 返回标签的基本信息和SEO相关信息 可用于页面标题、关键词和描述的设置 请求地址 {域名地址}/api/tag/detail 说明：{域名地址}

• 获取标签文档列表接口

  获取指定标签下的相关文档列表，支持多种排序方式和分页查询。 注意事项 该接口采用GET方法 需要提供标签ID或标签URL别名（filename）来指定查询的标签 支持多种排序方式，可根据需要选择不同的排序字段 支持分页查询，可以指定每页显示数量和页码 支持按不同方式获取数据（分页、列表、相关文档等） 返回文档的基本信息和扩展信息 请求地址 {域名地址}/api/tag/data/list 说明

• 获取文档分类接口

  获取系统中所有文档分类信息，支持按模块类型筛选（文章或产品），用于内容导入或分类管理功能。 注意事项 该接口采用GET方法 需要提供有效的后台导入接口Token进行身份验证 必须指定模块ID来获取对应的分类类型 支持获取文章分类和产品分类两种类型 返回的分类信息包含层级关系（通过parent_id区分） 请求地址 {域名地址}/api/import/categories

• 获取分类列表接口

  获取网站分类列表数据，支持按模型ID、上级分类等条件筛选，返回分类的详细信息。 注意事项 该接口用于获取网站的分类列表信息 支持按模型ID筛选特定模型的分类 支持获取指定上级分类的子分类 支持获取全部分类或按条件分页显示 需要确保域名地址正确配置 请求地址 {域名地址}/api/category/list 说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms

• 获取分类详情接口

  获取指定分类的详细信息，支持通过分类 ID 或 URL 别名获取分类详情，返回分类的基本信息、内容等。 注意事项 接口支持通过分类 ID 或 URL 别名（filename/catname）两种方式获取分类详情 分类类型包括普通分类（type=1）和单页面（type=3） 返回的分类信息包含 SEO 相关字段，便于 SEO 优化 如果分类不存在，接口会返回错误码 请求地址

• 获取单页详情接口

  获取单页内容的详细信息，支持通过单页ID或URL别名获取单页内容。 注意事项 该接口采用GET方法 支持通过ID或filename参数获取单页内容 返回单页的完整信息，包括标题、内容、SEO信息等 只返回已发布状态的单页内容（status为1） 请求地址 {域名地址}/api/page/detail 说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms

• 获取单页列表接口

  获取所有单页的列表信息，返回系统中所有已发布的单页内容。 注意事项 该接口采用GET方法 不需要任何请求参数 返回所有已发布状态的单页列表 包含单页的基本信息、SEO信息和内容摘要 请求地址 {域名地址}/api/page/list 说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms.com/api/page/list 请求语法 GET

• 添加友情链接接口

  添加新的友情链接到系统中，支持设置nofollow属性、反链信息、联系方式等详细信息。 注意事项 该接口采用POST方法，使用form-data格式提交数据 需要提供有效的后台导入接口Token进行身份验证 至少需要提供标题和链接两个必填参数 支持设置nofollow属性，有助于SEO优化 可以记录反链信息、联系方式和备注信息 请求地址 {域名地址}/api/friendlink/create

• 删除友情链接接口

  从系统中删除指定的友情链接记录，通过链接地址来识别需要删除的友情链接。 注意事项 该接口采用POST方法，使用form-data格式提交数据 需要提供有效的后台导入接口Token进行身份验证 必须提供要删除的友情链接地址 删除操作不可逆，请谨慎操作 成功删除后会返回成功消息 请求地址 {域名地址}/api/friendlink/delete?token={token} 说明：{域名地址}

• 获取友情链接列表接口

  获取网站的友情链接列表，返回所有已配置的友情链接信息，包括链接标题、URL、是否添加nofollow属性等详细信息。 注意事项 该接口采用GET方法，无需请求参数 返回所有已审核通过的友情链接信息 包含链接的基本信息和状态信息 支持nofollow设置，可控制SEO效果 返回的链接信息可用于前端展示 请求地址 {域名地址}/api/friendlink/list 说明：{域名地址}

• 获取评论列表接口

  获取网站评论列表数据，支持按文档ID筛选、分页显示等功能，返回评论的详细信息。 注意事项 该接口用于获取网站的评论列表信息 支持按文档ID筛选特定文档的评论 支持自定义排序方式 支持分页显示评论数据 需要确保域名地址正确配置 只返回已审核的评论（status=1），除非有特殊权限 请求地址 {域名地址}/api/comment/list 说明：{域名地址} 需要替换成你的域名地址，如

• 发布评论接口

  允许用户对指定文档发布评论，支持普通评论和回复评论功能。 注意事项 该接口采用POST方法，需要以application/json格式提交数据 需要提供有效的文档ID、用户名和评论内容 支持发布针对其他评论的回复（通过parent_id参数） 评论可能需要审核后才能显示（根据status字段判断） 需要确保域名地址正确配置 可能有评论频率限制，防止刷评论 请求地址

• 评论点赞接口

  对指定评论进行点赞操作，增加评论的点赞数，并返回更新后的评论信息。 注意事项 该接口采用POST方法，需要以application/json格式提交数据 需要提供有效的评论ID 每个IP或用户可能有限制，防止刷赞 需要确保域名地址正确配置 点赞成功后会返回更新后的评论信息及点赞数 请求地址 {域名地址}/api/comment/praise 说明：{域名地址} 需要替换成你的域名地址，如

• 获取留言表单字段接口

  获取网站留言表单的字段配置信息，包括字段名称、类型、是否必填等详细信息，用于前端动态生成留言表单。 注意事项 该接口采用GET方法，无需请求参数 返回留言表单的所有字段配置信息 包含字段名称、字段类型、是否必填等属性 支持多种表单字段类型：文本、数字、多行文本、单选、多选、下拉选择、图片、文件等 可用于前端动态渲染留言表单 请求地址 {域名地址}/api/guestbook/fields 说明

• 添加留言接口

  添加用户留言信息，支持用户名、留言内容、联系方式等基本信息，以及自定义表单字段的提交。 注意事项 该接口采用POST方法，需要以application/json格式提交数据 用户名字段为必填项 支持自定义留言表单字段 留言内容和联系方式为可选字段 提交后系统会返回操作结果信息 可用于网站的留言簿或反馈表单功能 请求地址 {域名地址}/api/guestbook.html 说明：{域名地址}

• 获取系统设置接口

  获取网站的基本系统配置信息，包括网站名称、Logo、备案号、版权信息等系统级设置参数。 注意事项 该接口采用GET方法 无需登录即可访问此接口 返回网站管理员在后台系统设置中的基本配置信息 包含网站基础信息和自定义系统参数 系统设置信息用于网站基础功能和显示配置 请求地址 {域名地址}/api/setting/system 说明：{域名地址} 需要替换成你的域名地址，如 https://www

• 获取联系方式接口

  获取网站的联系方式信息，包括联系人、联系电话、地址、邮箱等基本信息以及自定义的联系方式参数。 注意事项 该接口采用GET方法 无需登录即可访问此接口 返回网站管理员在后台设置的联系方式信息 包含基本联系方式和自定义联系方式字段 自定义参数根据后台设置而定，可能包含WhatsApp等其他联系方式 请求地址 {域名地址}/api/setting/contact 说明：{域名地址}

• 获取导航列表接口

  获取系统中所有导航菜单的信息，包括导航的层级结构、链接等信息。 注意事项 该接口采用GET方法，无需提交请求体数据 无需登录即可访问 支持获取指定类型的导航列表 返回结果包含导航的层级结构信息 默认获取类型ID为1的导航列表 请求地址 {域名地址}/api/nav/list 说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms.com/api/nav/list

• 上传图片资源接口

  上传图片或其他文件资源到系统中，支持指定资源分类，可用于替换已有资源。系统会自动处理图片尺寸并生成缩略图。 注意事项 此接口使用 POST 方法，Content-Type 为 form-data 上传文件需要用户登录并具有相应的上传权限 支持上传图片文件，系统会自动获取图片尺寸信息 可以通过指定 id 参数来替换已有资源 系统会自动生成缩略图并计算文件 MD5 值 请求地址

• 调用图形验证码接口

  获取图形验证码，返回包含验证码图片的 base64 编码和验证码 ID，用于防止自动化攻击和机器人注册等场景。 注意事项 接口无需任何请求参数 返回的验证码图片以 base64 编码格式提供，可以直接在前端显示 验证码 ID 用于后续验证请求，需要妥善保存 验证码具有时效性，过期后需要重新获取 请求地址 {域名地址}/api/captcha 说明：{域名地址} 需要替换成你的域名地址，如

• 文档发布接口

  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 说明：{域名地址}

• 获取首页 Banner 列表接口

  获取系统中指定分组的 Banner 列表，支持多个 Banner 分组，可以用于首页轮播图、广告位等展示场景。 注意事项 接口支持通过 type 参数获取不同分组的 Banner 默认获取 “default” 分组的 Banner 列表 Banner 包含图片、链接、描述等信息，便于前端展示 接口返回的 Banner 按照后台设置的排序返回 请求地址

• 登录接口

  用户登录接口，支持多种登录方式，包括网站登录、微信登录、Google登录等，用于验证用户身份并返回登录凭证。 注意事项 该接口采用POST方法，需要以application/json格式提交数据 支持多种平台登录，包括网站、微信、QQ、Google等 网站登录需要用户名和密码 微信登录需要提供相应用户信息和凭证 Google登录需要通过OAuth流程获取code

• 获取模型列表接口

  获取系统中所有内容模型（模块）的信息，包括模型的基本信息、自定义字段等。 注意事项 该接口采用GET方法，无需提交请求体数据 无需登录即可访问 返回结果包含系统内置模型和自定义模型 包含模型的自定义字段信息 请求地址 {域名地址}/api/module/list 说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms.com/api/module/list

• 获取模型详情接口

  获取指定内容模型的详细信息，包括模型的基本信息、自定义字段配置等，用于动态表单构建和内容管理。 注意事项 该接口采用GET方法 通过模型ID或模型URL别名来获取模型信息 支持获取系统内置模型和自定义模型的详细信息 返回模型的自定义字段列表，用于构建动态表单 模型信息包含字段类型、是否必填等配置信息 请求地址 {域名地址}/api/module/detail 说明：{域名地址}

• 获取用户收货地址接口

  获取当前登录用户的收货地址信息，该接口会返回最近一次使用的收货地址。 注意事项 该接口采用GET方法，无需提交请求体数据 需要用户登录后才能访问 返回最近一次使用的收货地址信息 如果用户没有收货地址，返回空数据 请求地址 {域名地址}/api/order/address 说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms

• 保存用户收货地址接口

  创建或更新用户的收货地址信息。 注意事项 该接口采用POST方法，需要以application/json格式提交数据 需要用户登录后才能访问 如果提供了ID参数，则更新现有地址；否则创建新地址 所有标记为必填的字段都需要提供值 请求地址 {域名地址}/api/order/address 说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms

• 取消订单接口

  取消用户指定的订单，将订单状态更新为已取消。 注意事项 该接口采用POST方法，需要以application/json格式提交数据 需要用户登录后才能访问 只能取消属于当前用户的订单 订单必须处于可取消状态才能被取消 请求地址 {域名地址}/api/order/cancel 说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms

• 创建订单接口

  创建用户购物订单，支持单个商品或多个商品下单，可指定收货地址、优惠券等信息。 注意事项 该接口采用POST方法，需要以application/json格式提交数据 需要用户登录后才能访问 订单状态为待付款状态，等待用户支付 可以通过商品ID或商品详情列表创建订单 支持使用优惠券和指定收货地址 请求地址 {域名地址}/api/order/create 说明：{域名地址} 需要替换成你的域名地址

• 获取订单详情接口

  获取指定订单的详细信息，包括订单状态、商品信息、收货地址等完整订单数据。 注意事项 该接口采用GET方法，无需提交请求体数据 需要用户登录后才能访问 只能获取属于当前用户的订单详情 返回完整的订单信息、商品详情和收货地址信息 请求地址 {域名地址}/api/order/detail 说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms

• 订单确认收货接口

  允许用户确认订单已收货，将订单状态更新为已完成。 注意事项 该接口采用POST方法，需要以application/json格式提交数据 需要提供订单ID作为确认收货的标识 仅登录用户可以调用此接口 订单必须处于”已发货”状态才能确认收货 确认收货后订单状态将变为”已完成” 请求地址 {域名地址}/api/order/finish 说明：{域名地址}

• 订单创建支付接口

  为待支付的订单创建支付，支持多种支付方式，包括微信、微信小程序、支付宝、PayPal和Stripe。 注意事项 该接口采用POST方法，需要以application/json格式提交数据 需要提供订单ID和支付方式 仅登录用户可以调用此接口 订单必须处于”待支付”状态才能创建支付 根据不同的支付方式返回相应的支付信息（二维码、跳转链接或小程序支付参数） 请求地址

• 订单申请退款接口

  允许用户为已完成或已支付的订单申请退款，提交退款申请后等待管理员审核处理。 注意事项 该接口采用POST方法，需要以application/json格式提交数据 需要提供订单ID作为退款申请的标识 仅登录用户可以调用此接口 订单必须处于”已完成”或”已支付”状态才能申请退款 申请退款后订单状态将变为”退款中”

• 获取订单列表接口

  获取用户的订单列表，支持按订单状态筛选和分页查询。 注意事项 该接口采用GET方法 需要用户登录验证 支持按订单状态筛选（待付款、已付款、已发货、已完成等） 支持分页查询，默认每页数量由pageSize参数决定 只返回当前登录用户的订单信息 请求地址 {域名地址}/api/orders 说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms

• 检查订单是否支付接口

  检查指定订单的支付状态，确认订单是否已完成支付。 注意事项 该接口采用GET方法 需要提供订单ID参数 需要用户登录验证（验证订单是否属于当前用户） 返回订单的支付状态信息 只能查询当前用户自己的订单 请求地址 {域名地址}/api/payment/check 说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms.com/api/payment/check

• 注册接口

  用户注册接口，用于创建新用户账户。 注意事项 该接口采用POST方法，需要以application/json格式提交数据 支持多种注册方式，可使用用户名密码或手机号验证码注册 可能需要图形验证码验证 注册成功后返回用户信息和登录凭证 用户名、邮箱或手机号需唯一 请求地址 {域名地址}/api/register 说明：{域名地址} 需要替换成你的域名地址，如 https://www

• 获取分销员收益列表接口

  获取分销员的收益列表，支持分页查询。 注意事项 该接口采用GET方法 需要用户登录验证 只返回当前登录用户的分销收益记录 支持分页查询，可指定当前页码和每页数量 包含订单金额、佣金金额、提现状态等信息 请求地址 {域名地址}/api/retailer/commissions 说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms

• 获取分销员详情接口

  获取指定分销员的详细信息，包括用户基本信息、分销状态和用户组信息。 注意事项 该接口采用GET方法 需要提供分销员ID参数 需要用户登录验证 返回分销员的完整用户信息和分组详情 包含分销员的累计收益、邀请码等信息 请求地址 {域名地址}/api/retailer/info 说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms

• 获取分销团队列表接口

  获取分销员的下级团队成员列表，支持分页查询。 注意事项 该接口采用GET方法 需要用户登录验证（当前用户必须是分销员） 只返回当前用户直接下级的成员列表 支持分页查询，可指定当前页码和每页数量 返回团队成员的基本信息和分销状态 请求地址 {域名地址}/api/retailer/members 说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms

• 获取分销订单列表接口

  获取分销员相关的订单列表，支持分页查询。 注意事项 该接口采用GET方法 需要用户登录验证（当前用户必须是分销员） 返回当前分销员推广产生的订单列表 支持分页查询，可指定当前页码和每页数量 包含订单的详细信息、买家信息和商品信息 请求地址 {域名地址}/api/retailer/orders 说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms

• 获取分销员统计信息接口

  获取分销员的统计信息，包括可提现佣金、已提现佣金、未结算佣金和团队人数。 注意事项 该接口采用GET方法 需要用户登录验证（当前用户必须是分销员） 无需任何请求参数 返回当前分销员的综合统计数据 包含财务统计和团队统计信息 请求地址 {域名地址}/api/retailer/statistics 说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms

• 更新分销员真实姓名接口

  更新分销员的真实姓名信息，用于修改分销员账户中的实名认证信息。 注意事项 该接口采用POST方法，需要以application/json格式提交数据 需要用户登录后才能调用此接口 只有分销员身份的用户可以更新自己的真实姓名 真实姓名更新可能需要进行实名认证验证 请求地址 {域名地址}/api/retailer/update 说明：{域名地址} 需要替换成你的域名地址，如 https://www

• 申请提现接口

  提交分销员的提现申请，将账户余额提取到指定的银行账户或支付平台。 注意事项 该接口采用POST方法，需要以application/json格式提交数据 需要用户登录后才能调用此接口 提现金额需要符合系统设定的最低提现额度 提现申请提交后需要等待管理员审核处理 需要确保账户余额充足且符合提现条件 请求地址 {域名地址}/api/retailer/withdraw 说明：{域名地址}

• 获取提现列表接口

  获取分销员的提现申请记录列表，支持分页查询和状态筛选。 注意事项 该接口采用GET方法 需要用户登录后才能调用此接口 只返回当前登录用户的提现记录 支持分页查询，默认每页显示固定数量的记录 提现记录包含不同状态：等待处理、已同意、已提现、提现错误 请求地址 {域名地址}/api/retailer/withdraw 说明：{域名地址} 需要替换成你的域名地址，如 https://www

• 获取首页TDK接口

  获取网站首页的SEO信息，包括标题(Title)、关键词(Keywords)和描述(Description)等TDK配置信息。 注意事项 该接口采用GET方法 无需登录即可访问此接口 返回网站管理员在后台设置的首页SEO配置信息 TDK信息用于SEO优化，包含首页标题、关键词和描述 这些信息通常用于浏览器标签页标题和搜索引擎展示 请求地址 {域名地址}/api/setting/index 说明

• 获取用户详情接口

  获取指定用户的基本信息和账户详情，包括用户名、联系方式、账户状态、余额等用户相关数据。 注意事项 该接口采用GET方法 需要提供目标用户的ID来查询用户详情 根据用户权限，可能只能查看自己的信息或有权限查看的用户信息 返回用户的基本信息和账户相关信息 请求地址 {域名地址}/api/user/detail 说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms

• 更新用户信息接口

  更新当前登录用户的基本信息，包括用户名、真实姓名、个人介绍、邮箱和手机号等个人信息。 注意事项 该接口采用POST方法，需要以application/json格式提交数据 需要用户登录后才能调用此接口 所有参数都是可选的，可以只更新需要修改的字段 用户名、邮箱和手机号可能需要唯一性验证 更新成功后会返回操作结果 请求地址 {域名地址}/api/user/detail 说明：{域名地址}

• 获取用户分组详情接口

  获取指定用户分组的详细信息，包括分组名称、等级、价格、配置信息等用户分组相关数据。 注意事项 该接口采用GET方法 需要提供用户分组ID来查询分组详情 返回用户分组的基本信息和配置信息 配置信息包括分享收益、上级收益、折扣和过期天数等设置 可能需要特定权限才能访问某些分组信息 请求地址 {域名地址}/api/user/group/detail 说明：{域名地址} 需要替换成你的域名地址，如

• 获取用户分组列表接口

  获取系统中所有用户分组的列表信息，包括各分组的名称、等级、价格、配置等详细信息。 注意事项 该接口采用GET方法 无需登录即可访问此接口 返回系统中所有可用的用户分组信息 包含分组的基本信息和配置信息 配置信息包括分享收益、上级收益、折扣和过期天数等设置 请求地址 {域名地址}/api/user/groups 说明：{域名地址} 需要替换成你的域名地址，如 https://www

• 修改用户密码接口

  修改当前登录用户的密码，需要验证原密码的正确性后才能更新为新密码。 注意事项 该接口采用POST方法，需要以application/json格式提交数据 需要提供原密码和新密码 需要用户已登录，通过会话或Token验证身份 新密码需要满足安全要求（如长度、复杂度等） 修改成功后可能需要重新登录 请求地址 {域名地址}/api/user/password 说明：{域名地址}

• 生成小程序码接口

  生成小程序码（二维码），用于在微信小程序中快速进入指定页面，支持携带场景参数。 注意事项 该接口采用POST方法，需要以application/json格式提交数据 需要提供小程序路径和场景参数 生成的小程序码可用于分享和推广 部分参数有长度和格式限制 需要配置小程序相关信息才能正常使用 请求地址 {域名地址}/api/weapp/qrcode 说明：{域名地址} 需要替换成你的域名地址，如

• 微信公众号服务地址接口

  微信公众号服务器配置接口，用于接收和处理微信服务器发送的消息和事件。 注意事项 该接口采用GET和POST两种方法，用于微信服务器验证和消息接收 仅用于微信公众号服务器配置，不适用于普通API调用 需要在微信公众号后台配置此接口地址 需要实现微信官方的验证机制 该接口需要处理微信服务器发送的各类消息和事件 请求地址 {域名地址}/api/wechat 说明：{域名地址} 需要替换成你的域名地址

• 微信官方授权接口

  微信网页授权登录接口，用于在微信环境中实现用户授权登录功能，支持获取用户基本信息和下发验证码。 注意事项 该接口采用GET方法，是一个跳转接口 需要在微信内置浏览器中访问才能正常工作 会先跳转到微信官方授权页面，用户授权后返回 当state参数为code时，会向用户微信下发验证码 需要预先配置微信公众号授权回调域名 请求地址 {域名地址}/api/wechat/auth 说明：{域名地址}

• 手动更新Sitemap接口

  手动触发系统重新生成站点地图(Sitemap)，支持同步和异步两种处理方式，用于更新搜索引擎索引。 注意事项 该接口采用POST方法，使用form-data格式提交数据 需要提供有效的后台导入接口Token进行身份验证 支持同步和异步处理模式，异步模式适合大量内容的站点 同步模式会等待Sitemap生成完成才返回结果 异步模式立即返回处理结果，后台继续执行生成任务 请求地址

• 导入图片资源接口

  导入图片资源到系统中，支持指定资源分类、替换已有资源等功能。该接口主要用于后台内容管理系统的图片上传和管理。 注意事项 该接口采用POST方法，使用form-data格式提交数据 需要提供有效的后台导入接口Token进行身份验证 支持指定图片资源分类ID 支持替换已存在的图片资源（通过ID指定） 上传成功后返回图片的详细信息和访问地址 请求地址 {域名地址}/attachment/upload

• 获取收藏列表接口

  获取当前用户的收藏列表，支持分页查询，返回用户收藏的所有商品或文档信息。 注意事项 该接口采用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列表 如果产品不存在，接口会返回错误码 请求地址

• 更新用户头像接口

  允许用户上传自定义头像图片，支持常见的图片格式，用于更新用户个人资料中的头像信息。 注意事项 该接口采用POST方法，需要以form-data格式提交数据 需要用户登录后才能调用此接口 上传的文件必须是图片格式（如JPG、PNG、WEBP等） 文件大小和格式可能有限制，具体取决于系统配置 上传成功后会自动更新当前登录用户的头像 请求地址 {域名地址}/api/user/avatar 说明

• 退出登录接口

  用户退出登录，清除当前登录状态和会话信息，支持返回HTML页面或JSON数据格式。 注意事项 该接口采用GET方法 需要提供随机字符串防止接口被缓存 支持返回HTML页面或JSON数据格式 退出登录后会清除用户会话信息 适用于网站前端用户退出功能 请求地址 {域名地址}/logout 说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms.com/logout

• 发送Email验证接口

  向指定邮箱地址发送验证邮件，邮件中包含验证链接，用户点击链接完成邮箱验证。 注意事项 该接口采用POST方法，需要以application/json格式提交数据 该接口用于向指定邮箱发送验证邮件 邮件中包含验证链接，用户点击后完成验证 支持多种验证场景（邮箱验证、重置密码等） 需要提供有效的邮箱地址和验证状态 邮件发送成功后会返回成功信息，但不保证用户一定会收到邮件 请求地址

• 验证Email地址接口

  验证邮箱地址的有效性，支持邮箱验证和重置密码等不同场景的验证。 注意事项 该接口用于验证邮箱地址的有效性 支持多种验证场景（邮箱验证、重置密码等） 通过token和code参数确保请求来源的有效性 支持返回json或html格式的数据 验证成功后会根据state参数执行相应操作 需要确保域名地址正确配置 请求地址 {域名地址}/api/verify/email 说明：{域名地址}

• 重置用户密码接口

  通过邮箱验证的方式重置用户密码，用户需要提供邮箱地址、新密码以及验证令牌和验证码。 注意事项 该接口采用POST方法，需要以application/json格式提交数据 目前只能通过邮箱方式重置用户密码 需要配合邮箱发送邮件功能使用，用户需要先获取验证链接 需要提供邮箱发送的验证token和code值 新密码需要符合系统密码强度要求 验证信息有有效期限制，过期后需要重新发送验证邮件 请求地址

• 获取订单统计数据接口

  获取当前用户的订单统计数据，包括各种状态的订单数量统计。 注意事项 该接口采用GET方法 需要用户登录验证 返回当前用户的订单统计信息 包含各种订单状态的数量统计 包含愿望清单数量统计 请求地址 {域名地址}/api/orders/statistics 说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms.com/api/orders/statistics

• 获取订单统计图表接口

  获取订单统计图表数据，支持按不同订单状态查询历史趋势。 注意事项 该接口采用GET方法 需要用户登录验证 支持查询不同订单状态的数据（待付款、待发货、待收货等） 返回指定时间范围内的订单统计趋势数据 数据以日期为维度，包含订单数量统计 请求地址 {域名地址}/api/orders/chart 说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms

• 获取商品Checkout信息接口

  获取商品结算信息，支持单个商品或多个商品的订单结算，包含优惠计算、地址信息等。 注意事项 该接口采用POST方法，需要以application/json格式提交数据 支持单个商品下单（通过goods_id、quantity、goods_sku_id参数）或多个商品下单（通过details参数） 支持使用优惠券（优惠券码或优惠券ID） 需要用户登录验证 支持设置收件地址和订单备注 请求地址

• 获取订单地址列表接口

  API 调用地址 {域名地址}/api/order/addresses 说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms.com/api/order/addresses 调用方法 GET 请求参数 无 返回参数 字段名 类型 说明 code int 错误码 msg string 错误原因说明 data object[] 结果内容 data 结果的 item

• 获取愿望清单列表接口

  获取当前登录用户的愿望清单列表，支持分页查询，返回用户收藏的商品信息。 注意事项 该接口采用GET方法，无需请求体 需要用户已登录，通过会话或Token验证身份 支持分页查询，可通过参数控制每页显示数量和当前页码 返回愿望清单中商品的详细信息，包括价格、备注等 包含商品当前价格和添加时的价格对比 请求地址 {域名地址}/api/wishlist/list 说明：{域名地址}

• 添加愿望清单接口

  将指定商品添加到用户的愿望清单中，支持设置备注、价格、优先级等信息。 注意事项 该接口采用POST方法，需要以application/json格式提交数据 需要提供商品ID，可选择性提供SKU ID 需要用户已登录，通过会话或Token验证身份 可以设置愿望价格、备注和优先级 如果商品已在愿望清单中，则可能更新现有记录 请求地址 {域名地址}/api/wishlist/add 说明：{域名地址}

• 移除愿望清单接口

  从用户的愿望清单中删除指定的商品记录。 注意事项 该接口采用POST方法，需要以application/json格式提交数据 需要提供愿望清单记录ID 需要用户已登录，通过会话或Token验证身份 只能删除属于当前用户愿望清单中的记录 删除操作不可逆，请谨慎操作 请求地址 {域名地址}/api/wishlist/delete 说明：{域名地址} 需要替换成你的域名地址，如 https

• 获取可用优惠券列表接口

  获取当前用户当前情况下可以使用的优惠券列表，支持按订单金额和商品ID筛选。 注意事项 该接口用于获取当前用户可用的优惠券列表 可通过amount参数筛选适用于指定金额订单的优惠券 可通过archive_id参数筛选适用于指定商品的优惠券 需要用户登录后才能获取优惠券列表 需要确保域名地址正确配置 返回的是当前时间有效且未使用的优惠券 优惠券的有效性包括时间范围、使用条件等限制 请求地址

• 获取我的优惠券列表接口

  获取当前用户已领取的优惠券列表，支持分页显示和状态筛选功能。 注意事项 该接口用于获取当前用户的优惠券列表信息 支持分页查询，可通过current和pageSize参数控制分页 支持按状态筛选优惠券（未使用、已使用或全部） 需要用户登录后才能获取优惠券列表 需要确保域名地址正确配置 返回结果包含总数信息，便于前端分页处理 请求地址 {域名地址}/api/coupon/codes 说明

• 领取优惠券接口

  允许用户领取指定的优惠券，通过提供优惠券ID来获取优惠券。 注意事项 该接口采用POST方法，需要以application/json格式提交数据 需要提供有效的优惠券ID 用户需要登录才能领取优惠券 优惠券可能有领取数量限制或时间限制 需要确保域名地址正确配置 同一用户可能无法重复领取同一张优惠券 请求地址 {域名地址}/api/coupon/code 说明：{域名地址}

• 获取购物车列表接口

  API 调用地址 {域名地址}/api/cart/list 说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms.com/api/cart/list 调用方法 GET Header 或者 Cookie 字段名 类型 必填 说明 cart string 否 当没有登录的时候，用此token作为用户判断 请求参数 字段名 类型 必填 说明 current int

• 添加购物车接口

  将指定商品添加到购物车中，支持指定商品 SKU、数量等信息，适用于电商功能中的购物车操作。 注意事项 该接口采用POST方法，需要以application/json格式提交数据 支持登录用户和未登录用户（通过 cart token 识别） 必须指定商品 ID 和数量 可以通过 SKU ID 指定具体的商品规格 如果商品已经在购物车中，则会更新数量而不是新增 请求地址

• 移除购物车商品接口

  从购物车中移除指定商品，根据购物车 ID 删除对应的购物车记录。 注意事项 该接口采用POST方法，需要以application/json格式提交数据 需要提供购物车记录的 ID 而不是商品 ID 支持登录用户和未登录用户（通过 cart token 识别） 删除成功后返回成功消息 请求地址 {域名地址}/api/cart/remove 说明：{域名地址} 需要替换成你的域名地址，如

• 更新购物车接口

  API 调用地址 {域名地址}/api/cart/update 说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms.com/api/cart/update 调用方法 POST Header 或者 Cookie 字段名 类型 必填 说明 cart string 否 当没有登录的时候，用此token作为用户判断 请求参数 | 字段名 | 类型 | 必填| 说明

• 获取沟通定制订单字段接口

  获取沟通定制订单可用的自定义字段信息，用于在创建沟通定制订单时提供表单字段。 注意事项 该接口采用GET方法，无需提交请求体数据 无需登录即可访问 返回所有可用的沟通定制订单字段配置 包含字段名称、类型、是否必填等信息 请求地址 {域名地址}/api/communication/fields 说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms

• 获取沟通定制订单列表

  获取用户沟通定制订单的列表信息，支持分页查询。 注意事项 该接口采用GET方法，无需提交请求体数据 需要用户登录后才能访问 返回当前用户的所有沟通定制订单 支持分页查询，可指定当前页码和每页数量 请求地址 {域名地址}/api/communication/orders 说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms

• 创建沟通定制订单接口

  创建沟通定制订单，用于用户提交定制需求，等待商家确认。 注意事项 该接口采用POST方法，需要以application/json格式提交数据 需要用户登录后才能访问 创建的订单需要商家确认后才能进入支付流程 订单状态为待确认状态，等待商家接受 请求地址 {域名地址}/api/communication/order/create 说明：{域名地址} 需要替换成你的域名地址，如 https

• 获取沟通定制订单详情接口

  获取沟通定制订单的详细信息，包括订单状态、沟通记录等。 注意事项 该接口采用GET方法，无需提交请求体数据 返回完整的订单信息和沟通记录 请求地址 {域名地址}/api/communication/order/detail 说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms.com/api/communication/order/detail 请求语法

• 更新沟通定制订单接口

  更新沟通定制订单的基本信息，包括标题、内容和订单额外信息。 注意事项 该接口采用POST方法，需要以application/json格式提交数据 需要用户登录后才能访问 只能更新属于当前用户的订单 订单ID为必填参数，用于指定要更新的订单 请求地址 {域名地址}/api/communication/order/update 说明：{域名地址} 需要替换成你的域名地址，如 https://www

• 沟通定制订单接受报价接口

  注意事项 该接口采用POST方法，需要以application/json格式提交数据 需要用户登录后才能访问 订单状态为待付款状态，等待用户支付 可以通过商品ID或商品详情列表创建订单 该接口与创建订单接口参数相同，专门用于接受定制订单 请求地址 {域名地址}/api/communication/order/accept 说明：{域名地址} 需要替换成你的域名地址，如 https://www

• 获取沟通定制订单沟通信息列表接口

  获取指定沟通定制订单的沟通记录列表，支持分页查询。 注意事项 该接口采用GET方法，无需提交请求体数据 需要用户登录后才能访问 只能获取属于当前用户订单的沟通记录 支持分页查询，可指定当前页码和每页数量 请求地址 {域名地址}/api/communication/messages 说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms

• 发送沟通定制订单信息接口

  向指定的沟通定制订单发送消息，用于用户和管理员之间的沟通交流。 注意事项 该接口采用POST方法，需要以application/json格式提交数据 需要用户登录后才能访问 只能向属于当前用户的订单发送消息 支持多种消息类型：文本、图片、报价、视频、文件等 请求地址 {域名地址}/api/communication/message/send 说明：{域名地址} 需要替换成你的域名地址，如

• 获取产品/订单评价列表接口

  获取产品或订单的评价列表，支持按商品、用户等条件筛选和分页查询。 注意事项 该接口采用GET方法 支持按商品ID、用户ID、订单ID等条件筛选 支持自定义排序方式 支持分页查询，默认每页10条记录 只返回已审核通过的评价（状态为1） 请求地址 {域名地址}/api/review/list 说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms

• 发表产品/订单评价接口

  允许用户对已购买的产品或订单进行评价，支持文字评价、评分和图片上传。 注意事项 该接口采用POST方法，需要以application/json格式提交数据 需要提供文档ID和评价内容 支持登录用户和未登录用户（未登录用户需提供用户名） 可以通过订单ID关联评价特定订单 支持1-5分的评分系统 支持上传多张评价图片 评价需要审核后才能显示 请求地址

• 获取多语言列表接口

  获取系统中所有可用的语言列表信息，包括语言标识、图标、链接等，用于多语言站点的切换功能。 注意事项 该接口采用GET方法 无需身份验证或特殊权限 返回系统中所有已配置的语言信息 包含当前语言标识和切换链接 用于多语言站点的语言切换功能 请求地址 {域名地址}/api/languages 说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms