Anqi CMS interface help

AnqiCMS supports API interface call data, and the supported calls include: document interface, document tag interface, classification page interface, and other commonly used interfaces.

• Import document interface

  API call address {domain address}/api/import/archive?token={token} Description: {domain address} needs to be replaced with your domain address, {token} needs to be replaced with the token in the background content import interface function, such as /api/import/archive?token=xxx Call method POST form-d

• Get the document list interface

  API call address {domain address}/api/archive/list description: {domain address} needs to be replaced with your domain address, such as /api/archive/list call method GET request parameter Field name Type Required Description id int No Document ID, when you want to obtain type=related, moduleId needs to be specified

• Get document details interface

  API call address {domain address}/api/archive/detail Description: {domain address} It needs to be replaced with your domain address, such as /api/archive/detail Call method GET request parameters Field name Type Required Description id int Yes Document ID, if filename is passed, you do not need to pass the ID filename st

• Get the previous document interface

  API call address {domain address}/api/archive/prev Description: {domain address} It needs to be replaced with your domain address, such as /api/archive/prev Call method GET request parameter Field name Type Required Description id int Yes Document ID Return parameter Field name Type Description code int Error code msg stri

• Get the next document interface

  API call address {domain address}/api/archive/next Description: {domain address} It needs to be replaced with your domain address, such as /api/archive/next Call method GET request parameter Field name Type Required Description id int Yes Document ID Return parameter Field name Type Description code int Error code msg stri

• Get document parameter filtering interface

  API call address {domain address}/api/archive/filters Description: {domain address} It needs to be replaced with your domain address, such as /api/archive/filters Call method GET request parameter Field name Type Required Description moduleId int Yes Model ID Return parameter Field name Type Description code int

• Get document parameters interface

  API call address {domain address}/api/archive/params Description: {domain address} It needs to be replaced with your domain address, such as /api/archive/params Call method GET request parameter Field name Type Required Description id int No Parameters obtain the specified document parameters based on the document id sorted int No Supported values ​​are

• Get the tag list interface

  API call address {domain address}/api/tag/list description: {domain address} It needs to be replaced with your domain address, such as /api/tag/list call method GET request parameter Field name Type Required Description itemId int No Document ID, read the tag list of the specified document. If not specified, all tags are read

• Get tag details interface

  API call address {domain address}/api/tag/detail description: {domain address} It needs to be replaced with your domain address, such as /api/tag/detail call method GET request parameters Field name Type Required Description id int Yes Tag ID, if filename is passed, you do not need to pass ID filename string No Tag

• Get tag document list interface

  API call address {domain address}/api/tag/data/list description: {domain address} It needs to be replaced with your domain address, such as /api/tag/data/list call method GET request parameters Field name Type Required Description id int Yes Tag ID. If filename is passed, you do not need to pass the ID filename stri

• Get the document classification interface

  API call address {domain address}/api/import/categories?token={token} Description: {domain address} needs to be replaced with your domain address, {token} needs to be replaced with the token in the background content import interface function, such as /api/import/categories?token=xxx Call method GET request parameter

• Get the classification list interface

  API call address {domain address}/api/category/list Description: {domain address} It needs to be replaced with your domain address, such as /api/category/list Call method GET request parameter Field name Type Required Description moduleId int No Model ID, you can get the classification list of the specified document model, such as moduleId="1

• Get the classification details interface

  API call address {domain address}/api/category/detail Description: {domain address} It needs to be replaced with your domain address, such as /api/category/detail Call method GET request parameters Field name Type Required Description id int Yes Classification ID. If filename is passed, you do not need to pass the ID filename

• Get the single page details interface

  API call address {domain address}/api/page/detail description: {domain address} It needs to be replaced with your domain address, such as /api/page/detail call method GET request parameters Field name Type Required Description id int Yes Single page ID, if filename is passed, you do not need to pass ID filename string No

• Get the single page list interface

  API call address {domain address}/api/page/list description: {domain address} needs to be replaced with your domain address, such as /api/page/list call method GET request parameter None Return parameter Field name Type Description code int Error code msg string Error cause description data object[] Result content da

• Add a friendly link interface

  API call address {domain address}/api/friendlink/create?token={token} Description: {domain address} needs to be replaced with your domain address, {token} needs to be replaced with the token in the background content import interface function, such as /api/friendlink/create?token=xxx Call method POST f

• Delete the friendly link interface

  API call address {domain address}/api/friendlink/delete?token={token} Description: {domain address} needs to be replaced with your domain address, {token} needs to be replaced with the token in the background content import interface function, such as /api/friendlink/delete?token=xxx Call method POST f

• Get the link list interface

  API call address {domain address}/api/friendlink/list description: {domain address} needs to be replaced with your domain address, such as /api/friendlink/list call method GET request parameter None Return parameter Field name Type Description code int Error code msg string Error cause description data obje

• Get comment list interface

  API call address {domain address}/api/comment/list description: {domain address} needs to be replaced with your domain address, such as /api/comment/list call method GET request parameter Field name Type Required Description id int No Document ID, specified document ID order string No Comment sorting, default id de

• Post comment interface

  API call address {domain address}/api/comment/publish description: {domain address} needs to be replaced with your domain address, such as /api/comment/publish call method POST application/json request parameters Field name Type Required Description archive_id int is the document id of the comment u

• Comment and Like Interface

  API call address {domain address}/api/comment/praise Description: {domain address} It needs to be replaced with your domain address, such as /api/comment/praise Call method POST application/json request parameter Field name Type Required Description id int Yes Comment ID Return parameter Field name Type Description

• Get the message form field interface

  API call address {domain address}/api/guestbook/fields Description: {domain address} It needs to be replaced with your domain address, such as /api/guestbook/fields Call method GET request parameter None Return parameter Field name Type Description code int Error code msg string Error cause description data ob

• Add a message interface

  API call address {domain address}/api/guestbook.html Description: {domain address} It needs to be replaced with your domain address, such as /api/guestbook.html Call method POST application/json request parameters Field name Type Required Description user_name string Yes Username conte

• Get the system settings interface

  API call address {domain address}/api/setting/system description: {domain address} needs to be replaced with your domain address, such as /api/setting/system call method GET request parameter None Return parameter Field name Type Description code int Error code msg string Error cause description data object

• Get the contact interface

  API call address {domain address}/api/setting/contact Description: {domain address} It needs to be replaced with your domain address, such as /api/setting/contact Call method GET request parameter None Return parameter Field name Type Description code int Error code msg string Error cause description data obje

• Get the navigation list interface

  API call address {domain address}/nav/list description: {domain address} It needs to be replaced with your domain address, such as /api/nav/list call method GET request parameter Field name Type Required Description typeId int No Navigation type, default: 1 Return parameter Field name Type Description code int Error code msg string

• Upload image resource interface

  API call address {domain address}/api/attachment/upload description: {domain address} It needs to be replaced with your domain address, such as /api/attachment/upload call method POST form-data request parameters Field name Type Required Description category_id int No Image resource category ID id

• Call the graphical verification code interface

  API call address {domain address}/api/captcha description: {domain address} needs to be replaced with your domain address, such as /api/captcha call method GET request parameter None Return parameter Field name Type Description code int Error code msg string Error reason description data object captcha content dat

• Document publishing interface

  API call address {domain address}/api/archive/publish Description: {domain address} needs to be replaced with your domain address, such as /api/archive/publish Call method POST application/json Request parameters Field name Type Required Description title string Yes Document title cont

• Check if the specified document has paid for the interface

  API call address { Domain address} /api/archive/order/check Description: { Domain address} needs to be replaced with your domain address, such as https://en.anqicms.com/api/archive/order/check Call method GET Request parameters Field name Type Required Description id int Yes Document ID Return parameter Field name Type Description code int Error code msg string

• Verify document password interface

  API call address { Domain address} /api/archive/password/check Description: { Domain address} needs to be replaced with your domain address, such as https://en.anqicms.com/api/archive/password/check Call method POST Request parameters Field name Type Required Description id int Yes Document ID password string Yes Entered password Return parameter Field name

• Get the homepage Banner list interface

  API call address { Domain address} /api/banner/list Description: { Domain address} needs to be replaced with your domain address, such as https://en.anqicms.com/api/banner/list Call method GET Request parameters Field name Type Required Description type string No Default value "default", you can create multiple banner groups in the background, and then use type to call banners of different groups

• Login interface

  API call address { Domain address} /api/login Description: { Domain address} It needs to be replaced with your domain address, such as https://en.anqicms.com/api/login Call method POST Request parameters Field name Type Required Description platform string Yes Login method, the default value is website, optional values ​​are: tt, swan, alipay, qq, weapp, wechat, inwechat

• Get the model list interface

  API call address { Domain address} /api/module/list Description: { Domain address} It needs to be replaced with your domain address, such as https://en.anqicms.com/api/module/list Call method GET Request parameter None Return parameter Field name Type Description code int Error code msg string Error cause description data object[] Result content data result item parameter

• Get the model details interface

  API call address { Domain address} /api/module/detail Description: { Domain address} It needs to be replaced with your domain address, such as https://en.anqicms.com/api/module/detail Call method GET Request parameters Field name Type Required Description id int Yes Model ID, if filename is passed, you do not need to pass ID filename string No Model URL alias, model ID

• Get user delivery address interface

  API call address { Domain address} /api/order/address Description: { Domain address} needs to be replaced with your domain address, such as https://en.anqicms.com/api/order/address Call method GET Request parameter None Return parameter Field name Type Description code int Error code msg string Error cause description data object Result content data result

• Save user delivery address interface

  This interface does not require calling API call address { Domain Name Address} /api/order/address Description: { Domain Name Address} needs to be replaced with your domain name address, such as https://en.anqicms.com/api/order/address Call method POST Request Parameter Field Name Type Required Description id int No Address ID name string Yes Recipient phone string Yes Contact number

• Cancel the order interface

  API call address { Domain address} /api/order/cancel Description: { Domain address} needs to be replaced with your domain address, such as https://en.anqicms.com/api/order/cancel Call method POST Request parameter Field name Type Required Description order_id string Yes Order ID Return parameter Field name Type Description code int Error code msg string

• Create an order interface

  API call address { Domain address} /api/order/create Description: { Domain address} It needs to be replaced with your domain address, such as https://en.anqicms.com/api/order/create Call method POST Request parameters Field name Type Required Description goods_id int No Product ID quantity int No Product quantity details object[] No Multiple product information

• Get Order Details Interface

  API call address { Domain address} /api/order/detail Description: { Domain address} needs to be replaced with your domain address, such as https://en.anqicms.com/api/order/detail Call method GET Request parameters Field name Type Required Description order_id string Yes Order ID Return parameter Field name Type Description code int Error code msg string

• Order confirmation receipt interface

  API call address { Domain address} /api/order/finish Description: { Domain address} needs to be replaced with your domain address, such as https://en.anqicms.com/api/order/finish Call method POST Request parameters Field name Type Required Description order_id string Yes Order ID Return parameter Field name Type Description code int Error code msg string

• Order creation payment interface

  API call address { Domain address} /api/order/payment Description: { Domain address} It needs to be replaced with your domain address, such as https://en.anqicms.com/api/order/payment Call method POST Request parameters Field name Type Required Description order_id string Yes Order ID pay_way string Yes Payment method: Optional values ​​are: wechat, weapp

• Order Refund Interface

  API call address { Domain address} /api/order/refund Description: { Domain address} needs to be replaced with your domain address, such as https://en.anqicms.com/api/order/refund Call method POST Request parameters Field name Type Required Description order_id string Yes Order ID Return parameter Field name Type Description code int Error code msg string

• Get the order list interface

  API call address { Domain address} /api/orders Description: { Domain address} It needs to be replaced with your domain address, such as https://en.anqicms.com/api/orders Call method GET Request parameters Field name Type Required Description status string No Order status, default is empty, supported values ​​are: empty value, waiting, paid, delivery, finished, refunding

• Check whether the order is paid interface

  API call address { Domain address} /api/payment/check Description: { Domain address} It needs to be replaced with your domain address, such as https://en.anqicms.com/api/payment/check Call method GET Request parameters Field name Type Required Description order_id string Yes Order ID Return parameter Field name Type Description code int Error code msg string

• Register interface

  API call address { Domain address} /api/register Description: { Domain address} needs to be replaced with your domain address, such as https://en.anqicms.com/api/register Call method POST Request parameters Field name Type Required Description user_name string No User name password string No Password captcha_id string No Graphic verification code ID

• Get the distribution staff income list interface

  API call address { Domain address} /api/retailer/commissions Description: { Domain address} needs to be replaced with your domain address, such as https://en.anqicms.com/api/retailer/commissions Call method GET Request parameters Field name Type Required Description Current int No Get the specified paging data, current page number pageSize int No Display quantity, number per page

• Get the distribution staff details interface

  API call address { Domain address} /api/retailer/info Description: { Domain address} It needs to be replaced with your domain address, such as https://en.anqicms.com/api/retailer/info Call method GET Request parameters Field name Type Required Description Retailer_id int Yes Distributor ID Return parameter Field name Type Description code int Error code msg string

• Get the distribution team list interface

  API call address { Domain address} /api/retailer/members Description: { Domain address} It needs to be replaced with your domain address, such as https://en.anqicms.com/api/retailer/members Call method GET Request parameters Field name Type Required Description current int No Get the specified paging data, current page number pageSize int No Display quantity, number per page Return parameters

• Get the distribution order list interface

  API call address { Domain address} /api/retailer/orders Description: { Domain address} It needs to be replaced with your domain address, such as https://en.anqicms.com/api/retailer/orders Call method GET Request parameters Field name Type Required Description Current int No Get the specified paging data, current page number pageSize int No Display quantity, number per page Return parameter Field name

• Obtain the distribution staff statistics interface

  API call address { Domain address} /api/retailer/statistics Description: { Domain address} It needs to be replaced with your domain address, such as https://en.anqicms.com/api/retailer/statistics Call method GET Request parameter None Return parameter Field name Type Description code int Error code msg string Error cause description data object Result content

• Get update the real name interface for the distribution staff

  API call address { Domain address} /api/retailer/update Description: { Domain address} It needs to be replaced with your domain address, such as https://en.anqicms.com/api/retailer/update Call method POST Request parameters Field name Type Required Description real_name string No Real name Return parameter Field name Type Description code int Error code msg

• Get the cash withdrawal interface

  API call address { Domain address} /api/retailer/withdraw Description: { Domain address} needs to be replaced with your domain address, such as https://en.anqicms.com/api/retailer/withdraw Call method POST Request parameter None Return parameter Field name Type Description code int Error code msg string Error reason description Request data example None Return data example {

• Get cash withdrawal list interface

  API call address { Domain address} /api/retailer/withdraw Description: { Domain address} needs to be replaced with your domain address, such as https://en.anqicms.com/api/retailer/withdraw Call method GET Request parameters Field name Type Required Description Current int No Get the specified paging data, current page number pageSize int No Display quantity, number per page Return parameters

• Get the home page TDK interface

  API call address { Domain address} /api/setting/index Description: { Domain address} needs to be replaced with your domain address, such as https://en.anqicms.com/api/setting/index Call method GET Request parameter None Return parameter Field name Type Description code int Error code msg string Error reason description data object Result content data result parameter Field name

• Get user details interface

  API call address { Domain address} /api/user/detail Description: { Domain address} needs to be replaced with your domain address, such as https://en.anqicms.com/api/user/detail Call method GET Request parameters Field name Type Required Description userId int Yes User ID Return parameter Field name Type Description code int Error code msg string Error cause description data

• Update user information interface

  API call address { Domain address} /api/user/detail Description: { Domain address} It needs to be replaced with your domain address, such as https://en.anqicms.com/api/user/detail Call method POST Request parameters Field name Type Required Description user_name string No Username real_name string No Real name email string No Email

• Get user group details interface

  API call address { Domain address} /api/user/group/detail Description: { Domain address} needs to be replaced with your domain address, such as https://en.anqicms.com/api/user/group/detail Call method GET Request parameters Field name Type Required Description id int Yes Group ID Return parameter Field name Type Description code int Error code msg string

• Get user group list interface

  API call address { Domain address} /api/user/groups Description: { Domain address} It needs to be replaced with your domain address, such as https://en.anqicms.com/api/user/groups Call method GET Request parameter None Return parameter Field name Type Description code int Error code msg string Error cause description data object[] Result content data result item parameter

• Modify user password interface

  API call address { Domain address} /api/user/password Description: { Domain address} needs to be replaced with your domain address, such as https://en.anqicms.com/api/user/password Call method POST Request parameters Field name Type Required Description old_password string Yes Old password password string Yes New password Return parameter Field name Type Description

• Generate applet code interface

  API call address { Domain address} /api/weapp/qrcode Description: { Domain address} It needs to be replaced with your domain address, such as https://en.anqicms.com/api/weapp/qrcode Call method POST Request parameters Field name Type Required Description path string Yes applet path scene string Yes scene Return parameter Field name Type Description code int

• WeChat official account service address interface

  API call address { Domain Address} /api/wechat Description: { Domain Address} needs to be replaced with your domain address, such as https://en.anqicms.com/api/wechat Call Method This interface is the WeChat official account service address, refer to the access guide GET/POST Description This interface is not an ordinary access interface, and is a WeChat official account service address interface. When configuring the WeChat official account, fill in the WeChat official account official website -> Development-Basic Settings

• Official WeChat authorization interface

  API call address { Domain Name Address} /api/wechat/auth Description: { Domain Name Address} needs to be replaced with your domain name address, such as https://en.anqicms.com/api/wechat/auth Call Method This interface is the WeChat login web page authorization call interface, which needs to be opened in WeChat. This interface is a jump interface, see Web page authorization GET request parameters Field name Type Required Description state string No state =

• Manually update the Sitemap interface

  API call address { Domain Address} /api/import/sitemap?token= { token} Description: { Domain Address} needs to be replaced with your domain address, {token} needs to be replaced with the token in the background content import interface function, such as https://en.anqicms.com/api/import/sitemap?token=xxx Call method POST form-data Request parameters GET parameters