安企CMS接口帮助

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

• 导入文档接口

  API 调用地址 {域名地址}/api/import/archive?token={token} 说明：{域名地址} 需要替换成你的域名地址，{token} 需要更换为后台内容导入接口功能里的Token，如 /api/import/archive?token=xxx 调用方法 POST form-d

• 获取文档列表接口

  API 调用地址 {域名地址}/api/archive/list说明：{域名地址} 需要替换成你的域名地址，如 /api/archive/list 调用方法 GET请求参数 字段名 类型 必填 说明 id int 否 文档ID，当要获取 type=related的时候需要指定 moduleId in

• 获取文档详情接口

  API 调用地址 {域名地址}/api/archive/detail说明：{域名地址} 需要替换成你的域名地址，如 /api/archive/detail 调用方法 GET请求参数 字段名 类型 必填 说明 id int 是 文档ID，如果传了filename，可以不用传ID filename st

• 获取上一个文档接口

  API 调用地址 {域名地址}/api/archive/prev说明：{域名地址} 需要替换成你的域名地址，如 /api/archive/prev 调用方法 GET请求参数 字段名 类型 必填 说明 id int 是 文档ID 返回参数 字段名 类型 说明 code int 错误码 msg stri

• 获取下一个文档接口

  API 调用地址 {域名地址}/api/archive/next说明：{域名地址} 需要替换成你的域名地址，如 /api/archive/next 调用方法 GET请求参数 字段名 类型 必填 说明 id int 是 文档ID 返回参数 字段名 类型 说明 code int 错误码 msg stri

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

  API 调用地址 {域名地址}/api/archive/filters说明：{域名地址} 需要替换成你的域名地址，如 /api/archive/filters 调用方法 GET请求参数 字段名 类型 必填 说明 moduleId int 是 模型ID 返回参数 字段名 类型 说明 code int

• 获取文档参数接口

  API 调用地址 {域名地址}/api/archive/params说明：{域名地址} 需要替换成你的域名地址，如 /api/archive/params 调用方法 GET请求参数 字段名 类型 必填 说明 id int 否 参数根据文档id获取指定的文档参数 sorted int 否 支持 的值有

• 获取标签列表接口

  API 调用地址 {域名地址}/api/tag/list说明：{域名地址} 需要替换成你的域名地址，如 /api/tag/list 调用方法 GET请求参数 字段名 类型 必填 说明 itemId int 否 文档ID，读取指定的文档的Tag列表。如果不指定，则读取所有的标签 letter stri

• 获取标签详情接口

  API 调用地址 {域名地址}/api/tag/detail说明：{域名地址} 需要替换成你的域名地址，如 /api/tag/detail 调用方法 GET请求参数 字段名 类型 必填 说明 id int 是 标签ID，如果传了filename，可以不用传ID filename string 否 标

• 获取标签文档列表接口

  API 调用地址 {域名地址}/api/tag/data/list说明：{域名地址} 需要替换成你的域名地址，如 /api/tag/data/list 调用方法 GET请求参数 字段名 类型 必填 说明 id int 是 标签ID，如果传了filename，可以不用传ID filename stri

• 获取文档分类接口

  API 调用地址 {域名地址}/api/import/categories?token={token}说明：{域名地址} 需要替换成你的域名地址，{token} 需要更换为后台内容导入接口功能里的Token，如 /api/import/categories?token=xxx 调用方法 GET请求参

• 获取分类列表接口

  API 调用地址 {域名地址}/api/category/list说明：{域名地址} 需要替换成你的域名地址，如 /api/category/list 调用方法 GET请求参数 字段名 类型 必填 说明 moduleId int 否 模型ID，可以获取指定文档模型的分类列表如 moduleId="1

• 获取分类详情接口

  API 调用地址 {域名地址}/api/category/detail说明：{域名地址} 需要替换成你的域名地址，如 /api/category/detail 调用方法 GET请求参数 字段名 类型 必填 说明 id int 是 分类ID，如果传了filename，可以不用传ID filename

• 获取单页详情接口

  API 调用地址 {域名地址}/api/page/detail说明：{域名地址} 需要替换成你的域名地址，如 /api/page/detail 调用方法 GET请求参数 字段名 类型 必填 说明 id int 是 单页ID，如果传了filename，可以不用传ID filename string 否

• 获取单页列表接口

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

• 添加友情链接接口

  API 调用地址 {域名地址}/api/friendlink/create?token={token}说明：{域名地址} 需要替换成你的域名地址，{token} 需要更换为后台内容导入接口功能里的Token，如 /api/friendlink/create?token=xxx 调用方法 POST f

• 删除友情链接接口

  API 调用地址 {域名地址}/api/friendlink/delete?token={token}说明：{域名地址} 需要替换成你的域名地址，{token} 需要更换为后台内容导入接口功能里的Token，如 /api/friendlink/delete?token=xxx 调用方法 POST f

• 获取友情链接列表接口

  API 调用地址 {域名地址}/api/friendlink/list说明：{域名地址} 需要替换成你的域名地址，如 /api/friendlink/list 调用方法 GET请求参数 无 返回参数 字段名 类型 说明 code int 错误码 msg string 错误原因说明 data obje

• 获取评论列表接口

  API 调用地址 {域名地址}/api/comment/list说明：{域名地址} 需要替换成你的域名地址，如 /api/comment/list 调用方法 GET请求参数 字段名 类型 必填 说明 id int 否 文档ID，指定的文档ID order string 否 评论排序，默认 id de

• 发布评论接口

  API 调用地址 {域名地址}/api/comment/publish说明：{域名地址} 需要替换成你的域名地址，如 /api/comment/publish 调用方法 POST application/json请求参数 字段名 类型 必填 说明 archive_id int 是 评论的文档id u

• 评论点赞接口

  API 调用地址 {域名地址}/api/comment/praise说明：{域名地址} 需要替换成你的域名地址，如 /api/comment/praise 调用方法 POST application/json请求参数 字段名 类型 必填 说明 id int 是 评论ID 返回参数 字段名 类型 说明

• 获取留言表单字段接口

  API 调用地址 {域名地址}/api/guestbook/fields说明：{域名地址} 需要替换成你的域名地址，如 /api/guestbook/fields 调用方法 GET请求参数 无 返回参数 字段名 类型 说明 code int 错误码 msg string 错误原因说明 data ob

• 添加留言接口

  API 调用地址 {域名地址}/api/guestbook.html说明：{域名地址} 需要替换成你的域名地址，如 /api/guestbook.html 调用方法 POST application/json请求参数 字段名 类型 必填 说明 user_name string 是 用户名 conte

• 获取系统设置接口

  API 调用地址 {域名地址}/api/setting/system说明：{域名地址} 需要替换成你的域名地址，如 /api/setting/system 调用方法 GET请求参数 无 返回参数 字段名 类型 说明 code int 错误码 msg string 错误原因说明 data object

• 获取联系方式接口

  API 调用地址 {域名地址}/api/setting/contact说明：{域名地址} 需要替换成你的域名地址，如 /api/setting/contact 调用方法 GET请求参数 无 返回参数 字段名 类型 说明 code int 错误码 msg string 错误原因说明 data obje

• 获取导航列表接口

  API 调用地址 {域名地址}/nav/list说明：{域名地址} 需要替换成你的域名地址，如 /api/nav/list 调用方法 GET请求参数 字段名 类型 必填 说明 typeId int 否 导航类型，默认：1 返回参数 字段名 类型 说明 code int 错误码 msg string

• 上传图片资源接口

  API 调用地址 {域名地址}/api/attachment/upload说明：{域名地址} 需要替换成你的域名地址，如 /api/attachment/upload 调用方法 POST form-data请求参数 字段名 类型 必填 说明 category_id int 否 图片资源类别ID id

• 调用图形验证码接口

  API 调用地址 {域名地址}/api/captcha说明：{域名地址} 需要替换成你的域名地址，如 /api/captcha 调用方法 GET请求参数 无 返回参数 字段名 类型 说明 code int 错误码 msg string 错误原因说明 data object captcha内容 dat

• 文档发布接口

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

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

  API 调用地址 { 域名地址} /api/archive/order/check 说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms.com/api/archive/order/check 调用方法 GET 请求参数 字段名 类型 必填 说明 id int 是 文档ID 返回参数 字段名 类型 说明 code int 错误码 msg string

• 验证文档密码接口

  API 调用地址 { 域名地址} /api/archive/password/check 说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms.com/api/archive/password/check 调用方法 POST 请求参数 字段名 类型 必填 说明 id int 是 文档ID password string 是 输入的密码 返回参数 字段名

• 获取首页 Banner 列表接口

  API 调用地址 { 域名地址} /api/banner/list 说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms.com/api/banner/list 调用方法 GET 请求参数 字段名 类型 必填 说明 type string 否 默认值"default"，你可以在后台创建多个banner分组，然后通过type ，来调用不同分组的banner

• 登录接口

  API 调用地址 { 域名地址} /api/login 说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms.com/api/login 调用方法 POST 请求参数 字段名 类型 必填 说明 platform string 是 登录方式，默认值为website，可选值有：tt、swan、alipay、qq、weapp、wechat、inwechat

• 获取模型列表接口

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

• 获取模型详情接口

  API 调用地址 { 域名地址} /api/module/detail 说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms.com/api/module/detail 调用方法 GET 请求参数 字段名 类型 必填 说明 id int 是 模型ID，如果传了filename，可以不用传ID filename string 否 模型URL别名，模型ID

• 获取用户收货地址接口

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

• 保存用户收货地址接口

  该接口可以不需要调用 API 调用地址 { 域名地址} /api/order/address 说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms.com/api/order/address 调用方法 POST 请求参数 字段名 类型 必填 说明 id int 否 地址ID name string 是 收件人 phone string 是 联系电话

• 取消订单接口

  API 调用地址 { 域名地址} /api/order/cancel 说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms.com/api/order/cancel 调用方法 POST 请求参数 字段名 类型 必填 说明 order_id string 是 订单ID 返回参数 字段名 类型 说明 code int 错误码 msg string

• 创建订单接口

  API 调用地址 { 域名地址} /api/order/create 说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms.com/api/order/create 调用方法 POST 请求参数 字段名 类型 必填 说明 goods_id int 否 商品ID quantity int 否 商品数量 details object[] 否 多个商品信息

• 获取订单详情接口

  API 调用地址 { 域名地址} /api/order/detail 说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms.com/api/order/detail 调用方法 GET 请求参数 字段名 类型 必填 说明 order_id string 是 订单ID 返回参数 字段名 类型 说明 code int 错误码 msg string

• 订单确认收货接口

  API 调用地址 { 域名地址} /api/order/finish 说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms.com/api/order/finish 调用方法 POST 请求参数 字段名 类型 必填 说明 order_id string 是 订单ID 返回参数 字段名 类型 说明 code int 错误码 msg string

• 订单创建支付接口

  API 调用地址 { 域名地址} /api/order/payment 说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms.com/api/order/payment 调用方法 POST 请求参数 字段名 类型 必填 说明 order_id string 是 订单ID pay_way string 是 支付方式：可选值有：wechat、weapp

• 订单申请退款接口

  API 调用地址 { 域名地址} /api/order/refund 说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms.com/api/order/refund 调用方法 POST 请求参数 字段名 类型 必填 说明 order_id string 是 订单ID 返回参数 字段名 类型 说明 code int 错误码 msg string

• 获取订单列表接口

  API 调用地址 { 域名地址} /api/orders 说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms.com/api/orders 调用方法 GET 请求参数 字段名 类型 必填 说明 status string 否 订单状态，默认为空，支持的值有：空值、waiting、paid、delivery、finished、refunding

• 检查订单是否支付接口

  API 调用地址 { 域名地址} /api/payment/check 说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms.com/api/payment/check 调用方法 GET 请求参数 字段名 类型 必填 说明 order_id string 是 订单ID 返回参数 字段名 类型 说明 code int 错误码 msg string

• 注册接口

  API 调用地址 { 域名地址} /api/register 说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms.com/api/register 调用方法 POST 请求参数 字段名 类型 必填 说明 user_name string 否 用户名 password string 否 密码 captcha_id string 否 图形验证码ID

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

  API 调用地址 { 域名地址} /api/retailer/commissions 说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms.com/api/retailer/commissions 调用方法 GET 请求参数 字段名 类型 必填 说明 current int 否 获取指定分页数据，当前页码 pageSize int 否 显示数量，每页数量

• 获取分销员详情接口

  API 调用地址 { 域名地址} /api/retailer/info 说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms.com/api/retailer/info 调用方法 GET 请求参数 字段名 类型 必填 说明 retailer_id int 是 分销员ID 返回参数 字段名 类型 说明 code int 错误码 msg string

• 获取分销团队列表接口

  API 调用地址 { 域名地址} /api/retailer/members 说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms.com/api/retailer/members 调用方法 GET 请求参数 字段名 类型 必填 说明 current int 否 获取指定分页数据，当前页码 pageSize int 否 显示数量，每页数量 返回参数

• 获取分销订单列表接口

  API 调用地址 { 域名地址} /api/retailer/orders 说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms.com/api/retailer/orders 调用方法 GET 请求参数 字段名 类型 必填 说明 current int 否 获取指定分页数据，当前页码 pageSize int 否 显示数量，每页数量 返回参数 字段名

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

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

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

  API 调用地址 { 域名地址} /api/retailer/update 说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms.com/api/retailer/update 调用方法 POST 请求参数 字段名 类型 必填 说明 real_name string 否 真实姓名 返回参数 字段名 类型 说明 code int 错误码 msg

• 获取申请提现接口

  API 调用地址 { 域名地址} /api/retailer/withdraw 说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms.com/api/retailer/withdraw 调用方法 POST 请求参数 无 返回参数 字段名 类型 说明 code int 错误码 msg string 错误原因说明 请求数据示例 无 返回数据示例 {

• 获取提现列表接口

  API 调用地址 { 域名地址} /api/retailer/withdraw 说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms.com/api/retailer/withdraw 调用方法 GET 请求参数 字段名 类型 必填 说明 current int 否 获取指定分页数据，当前页码 pageSize int 否 显示数量，每页数量 返回参数

• 获取首页TDK接口

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

• 获取用户详情接口

  API 调用地址 { 域名地址} /api/user/detail 说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms.com/api/user/detail 调用方法 GET 请求参数 字段名 类型 必填 说明 userId int 是 用户ID 返回参数 字段名 类型 说明 code int 错误码 msg string 错误原因说明 data

• 更新用户信息接口

  API 调用地址 { 域名地址} /api/user/detail 说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms.com/api/user/detail 调用方法 POST 请求参数 字段名 类型 必填 说明 user_name string 否 用户名 real_name string 否 真实姓名 email string 否 邮箱

• 获取用户分组详情接口

  API 调用地址 { 域名地址} /api/user/group/detail 说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms.com/api/user/group/detail 调用方法 GET 请求参数 字段名 类型 必填 说明 id int 是 分组ID 返回参数 字段名 类型 说明 code int 错误码 msg string

• 获取用户分组列表接口

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

• 修改用户密码接口

  API 调用地址 { 域名地址} /api/user/password 说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms.com/api/user/password 调用方法 POST 请求参数 字段名 类型 必填 说明 old_password string 是 旧密码 password string 是 新密码 返回参数 字段名 类型 说明

• 生成小程序码接口

  API 调用地址 { 域名地址} /api/weapp/qrcode 说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms.com/api/weapp/qrcode 调用方法 POST 请求参数 字段名 类型 必填 说明 path string 是 小程序路径 scene string 是 scene 返回参数 字段名 类型 说明 code int

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

  API 调用地址 { 域名地址} /api/wechat 说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms.com/api/wechat 调用方法 该接口为微信公众号服务地址，参阅接入指南 GET/POST 说明 该接口非普通访问接口，为微信公众号服务地址接口，在配置微信公众号的时候，填写到微信公众号官网 -> 开发-基本设置 中

• 微信官方授权接口

  API 调用地址 { 域名地址} /api/wechat/auth 说明：{域名地址} 需要替换成你的域名地址，如 https://www.anqicms.com/api/wechat/auth 调用方法 该接口为微信登录网页授权调用接口，需要在微信中打开，该接口为一个跳转接口，参阅网页授权 GET 请求参数 字段名 类型 必填 说明 state string 否 state =