Anqi CMS API Help

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

• Document Import Interface

  Import document content in batches via the API interface, supporting the import of complete information such as document title, content, category, keywords, thumbnail, etc., and enabling batch migration and publishing of content. Notes The interface uses the POST method and submits data in form-data format. An effective token parameter must be provided in the URL for authentication. The document title, content, and category ID must be provided. Custom URL alias, keywords, description, thumbnail, and complete document information are supported. Document group image upload is supported, up to 9 images can be set, and the document publication time can be set.

• to get the document list interface

  Retrieve the document list with specified conditions in the system, supporting various filtering and sorting methods, and can obtain the document list under specified models, categories, recommended attributes, and other conditions.This interface is applicable to the content of documents and product types. Notes The interface supports various types of data retrieval (page, list, related), and the effect of different parameters may vary when type=“When using "page"}, it supports pagination and search functions, supports custom filtering parameters, and can be filtered according to the fields configured in the model. Some fields such as price

• Interface to Get Product/Document Details

  Retrieve detailed information of a single document in the AnQiCMS system, including basic document information, classification information, content details, and other custom field information.This interface is applicable to content of document and product types. Notes The interface supports retrieval of document details through document ID or URL alias (filename). You can get the previous and next documents through this interface. Some fields such as price, inventory, and SKU are only valid in product type documents. The response includes SEO-related fields for SEO optimization. If the document does not exist

• Get Previous Document Interface

  Retrieve information about the previous document of a specified document, usually used for the previous and next navigation function on the document detail page.If the specified document is the first document, an empty result is returned.Note: The interface searches for the previous document in the order of document ID. When the specified document is the first document, the returned data is null. Only the basic information of the document is returned, not the detailed content of the document. The interface will return the previous document in the same category. Request address {domain address}/api/archive/prev Note: {domain address} needs to be replaced with your domain address, such as

• Get Next Document Interface

  Retrieve the next document information for a specified document, usually used for the previous and next navigation function on the document detail page.If the specified document is the last document, an empty result is returned.Attention事项 The interface searches for the next document in order of document ID When the specified document is the last document, the returned data is null Only the basic information of the document is returned, not the detailed content of the document The interface will return the next document in the same category Request address {domain address}/api/archive/next Note: {domain address} needs to be replaced with your domain address

• Get document parameter filtering conditions interface

  Retrieve the document parameter filtering conditions for a specified model, return the fields and options available for filtering in the model, suitable for building the front-end interface of the document filtering function. Notes The interface requires specifying the model ID to retrieve the filtering conditions for the corresponding model The returned filtering conditions are based on the field types set in the model The filter options include total counts to help users understand the number of documents under each option The request address {domain address}/api/archive/filters Instructions: {domain address} needs to be replaced with your domain address, such as https://www

• Get Document Parameters Interface

  Retrieve custom parameter information for a specified document, supporting return in two formats: sorted array or unordered map object, used to obtain additional field information set in the document model. Notes: The interface supports obtaining parameters for a specific document through document ID. The return format is controlled by the sorted parameter: array format or object format. Parameter values separated by newline characters indicate that the field is of multi-select type. Request address {domain address}/api/archive/params Description: {domain address} needs to be replaced with your domain address, such as

• Get Tag List Interface

  Get the list of tags on the website, supporting retrieval of specific document tags by document ID, alphabetical filtering, and pagination queries. Notes: The interface uses the GET method to retrieve the complete list of tags or tags of specified documents. Supports alphabetical filtering of tags, supports pagination queries, can specify the number of items per page and page number, supports different return types (list or pagination), and returns basic information and SEO-related information of tags. Request address {domain address}/api/tag/list Notes: {domain address} needs to be replaced with your domain address, such as

• Get Tag Detail Interface

  Get detailed information about a specified tag, including the tag name, SEO information, link address, and other basic information. Notes: The interface uses the GET method and requires the tag ID or tag URL alias (filename) to specify the tag to be queried. Either the tag ID or the URL alias can be provided, but not both. If the filename parameter is provided, the ID does not need to be transmitted. Return the basic information and SEO-related information of the tag, which can be used for setting page titles, keywords, and descriptions. Request address {domain address}/api/tag/detail Note: {domain address}

• Get Tag Document List Interface

  Retrieve the list of documents related to a specified tag, supporting various sorting methods and pagination queries. Notes The interface uses the GET method and requires the tag ID or URL alias (filename) to specify the query tag Supports various sorting methods, and different sorting fields can be selected as needed Supports pagination queries, where the number of items per page and page number can be specified Supports retrieving data in various ways (pagination, list, related documents, etc.) Returns basic and extended information about the documents Request address {domain address}/api/tag/data/list Note

• Document Classification Interface

  Retrieve all document category information in the system, supporting filtering by module type (article or product), used for content import or classification management function. Notes The interface uses the GET method, an effective background import interface Token is required for authentication, the module ID must be specified to obtain the corresponding category type, supports obtaining article categories and product categories, the returned category information includes hierarchical relationships (distinguished by parent_id), request address {domain address}/api/import/categories

• Get Category List Interface

  Retrieve the website category list data, supporting filtering by model ID, parent category, etc., and returning detailed information about the categories.

• Get Category Detail Interface

  Retrieve detailed information of a specified category, supporting retrieval of category details through category ID or URL alias, returning basic information and content of the category. Notes The interface supports retrieval of category details through both category ID and URL alias (filename/catname), including common categories (type=1) and single-page categories (type=3). The returned category information includes SEO-related fields, facilitating SEO optimization. If the category does not exist, the interface will return an error code. Request address

• Retrieve single page details interface

  Get the detailed information of a single page, supporting retrieval of single page content through single page ID or URL alias.Note: This interface uses the GET method, supports retrieval of single-page content through ID or filename parameters, returns complete information of the single page including title, content, SEO information, etc., and only returns published single-page content (status is 1). Request address {domain address}/api/page/detail Note: {domain address} needs to be replaced with your domain address, such as https://www.anqicms

• Get Single Page List Interface

  Retrieve the list information of all single pages, return all the single page content that has been published in the system.Note that this interface uses the GET method, no request parameters are required, returns a list of all published single-page statuses, including basic information, SEO information, and content summary. Request address {domain address}/api/page/list Instructions: {domain address} Replace it with your domain address, such as https://en.anqicms.com/api/page/list Request syntax GET

• Add friend link interface

  Add a new friendship link to the system, supporting the setting of nofollow attributes, backlink information, contact information, and other detailed information. Notes: This interface uses the POST method, submits data in form-data format, requires a valid background import interface Token for authentication, at least two required parameters of title and link are provided, supports setting nofollow attributes, which is helpful for SEO optimization, and can record backlink information, contact information, and remarks. Request address {domain address}/api/friendlink/create

• Delete Friendship Link Interface

  Delete the specified friend link record from the system, identify the friend link to be deleted by the link address.Note: This interface uses the POST method, submits data in form-data format, requires a valid backend import interface Token for authentication, must provide the URL of the friend link to be deleted. The delete operation is irreversible, please operate with caution. A success message will be returned after a successful deletion. Request address {domain address}/api/friendlink/delete?token={token} Explanation: {domain address}

• Get friend link list interface

  Retrieve the website's friend link list, return all configured friend link information, including link title, URL, whether to add the nofollow attribute, etc. Notes: The interface uses the GET method and does not require any parameters, return all friend links that have passed the review, including the basic information and status information of the links, supports nofollow settings, which can control the SEO effect, and the returned link information can be used for front-end display, request address {domain address}/api/friendlink/list Description: {domain address}

• Get Comment List Interface

  Retrieve website comment list data, supporting filtering by document ID, pagination, and other functions, and returning detailed comment information. Notes: This interface is used to retrieve the website's comment list information, supporting filtering specific document comments by document ID, supporting custom sorting methods, supporting pagination of comment data, ensuring that the domain address is correctly configured, and only returning reviewed comments (status=1) unless special permissions are granted. Request address {domain address}/api/comment/list Notes: {domain address} needs to be replaced with your domain address, such as

• Post comment interface

  Allow users to post comments on specified documents, supporting general comments and reply comments features. Notes The interface uses the POST method, and data needs to be submitted in application/ format. It is necessary to provide a valid document ID, username, and comment content. It supports replying to other comments (via the parent_id parameter). Comments may need to be reviewed before they can be displayed (based on the status field). Ensure that the domain address is correctly configured. There may be comment frequency limits to prevent comment spam. Request address

• Comment and Like Interface

  Perform a like operation on a specified comment, increase the like count of the comment, and return the updated comment information. Notes The interface uses the POST method, and data needs to be submitted in application/ format An effective comment ID is required Each IP or user may be subject to restrictions to prevent like spam Ensure that the domain address is correctly configured On successful like, the updated comment information and like count will be returned Request address {domain address}/api/comment/praise Note: {domain address} needs to be replaced with your domain address, such as

• Get Message Form Field Interface

  Retrieve the field configuration information of the website's message form, including field names, types, and whether mandatory, etc., for the front-end to dynamically generate the message form. Notes: This interface uses the GET method and does not require any request parameters. Returns all field configuration information of the message form, including field names, field types, whether mandatory, etc. Supports various form field types: text, number, multi-line text, radio, checkbox, dropdown selection, image, file, etc., which can be used for the front-end to dynamically render the message form. Request address {domain address}/api/guestbook/fields description

• Leave a message interface

  Add user message information, supporting username, message content, contact information, and basic information such as custom form field submission.Note that this interface uses the POST method, requires data to be submitted in application/ format, the username field is required, supports custom message form fields, the message content and contact information are optional fields, after submission, the system will return the operation result information, which can be used for website message boards or feedback form functions, request address {domain address}/api/guestbook.html Note: {domain address}

• Get System Settings Interface

  Retrieve the basic system configuration information of the website, including website name, Logo, filing number, copyright information, and other system-level setting parameters. Notes: This interface uses the GET method and can be accessed without logging in. It returns the basic configuration information set in the background system by the website administrator, including basic website information and customized system parameters. System setting information is used for the basic functions and display configuration of the website. Request address {domain address}/api/setting/system Notes: {domain address} needs to be replaced with your domain address, such as https://www

• Get Contact Information Interface

  Retrieve the website's contact information, including contacts, phone numbers, addresses, emails, and other basic information as well as custom contact parameters. Notes: This interface uses the GET method and does not require login to access the interface. The interface returns the contact information set by the website administrator in the background, including basic contact information and custom contact fields. Custom parameters are determined according to the background settings and may include other contact methods such as WhatsApp. Request address {domain address}/api/setting/contact Note: {domain address}

• Get Navigation List Interface

  Get information about all navigation menus in the system, including the hierarchy structure, links, and more.Note that this interface uses the GET method, no request body data needs to be submitted, no login is required to access it, it supports retrieving a navigation list of a specified type, the returned results include the hierarchical structure information of the navigation, the default type ID for retrieval is 1, the request address is {domain address}/api/nav/list Note: {domain address} needs to be replaced with your domain address, such as https://en.anqicms.com/api/nav/list

• Upload Image Resource Interface

  Upload images or other file resources to the system, support specifying resource categories, which can be used to replace existing resources.The system will automatically handle image size and generate thumbnails. Notes This interface uses the POST method, Content-Type is form-data, uploading files requires the user to log in and have the corresponding upload permissions, supports uploading image files, the system will automatically obtain image size information, can be replaced by specifying the id parameter, the system will automatically generate thumbnails and calculate the file MD5 value, request address

• Call the graphic captcha interface

  Get the captcha image, return the base64 encoded captcha image and captcha ID, used to prevent automated attacks and robot registration scenarios. Notes The interface does not require any request parameters The captcha image is provided in base64 encoding format and can be directly displayed on the front-end The captcha ID is used for subsequent verification requests and should be kept properly The captcha has an expiration time and needs to be retrieved again after expiration The request address {domain address}/api/captcha Notes: {domain address} should be replaced with your domain address, such as

• Document publication interface

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

• Check if the specified document has paid interface

  Check if the currently logged-in user has purchased or paid for the specified document content, used to verify the user's access permission for paid documents. Notes: This interface requires the user to be logged in; otherwise, it will return an unlogged error. It is only applicable to documents that have set paid access. The interface returns a boolean value indicating whether the current user has paid for the document. If a non-logged-in user calls this interface, it will return error code 1001. Request address {domain address}/api/archive/order/check Note: {domain address} needs to be replaced with your domain address, such as https

• Verify document password interface

  Verify if the password to access the password-protected document is correct, used to protect the document content that requires password access.After verification, return the document content, or return an error message if verification fails.Attention: This interface uses the POST method to submit a verification request. The interface requires the document ID and password to be provided for verification. If the verification is successful, the document content will be returned, and if the verification fails, an error message will be returned. It is only applicable to documents that have password protection. Request address {domain address}/api/archive/password/check Note: {domain address}

• Get home page Banner list interface

  Retrieve the list of Banners for a specified group in the system, supporting multiple Banner groups, which can be used for display scenarios such as home page carousel, advertising positions, etc. Notes The interface supports retrieving different groups of Banners through the type parameter. The default Banner list for the “default” group is retrieved. Banners include images, links, descriptions, and other information, convenient for front-end display. The returned Banners are sorted according to the backend settings. Request address

• Login interface

  User login interface, supporting various login methods, including website login, WeChat login, Google login, etc., used to verify user identity and return login credentials. Notes The interface uses the POST method and requires data to be submitted in application/ format It supports multiple platform logins, including website, WeChat, QQ, Google, etc. Website login requires username and password WeChat login requires corresponding user information and credentials Google login requires obtaining the code through the OAuth process

• Retrieve model list interface

  Retrieve information about all content models (modules) in the system, including basic information and custom fields.Attention: This interface uses the GET method, no request body data needs to be submitted, no login is required to access it, the return results include built-in system models and custom models, including custom field information of the models, request address {domain address}/api/module/list Note: {domain address} needs to be replaced with your domain address, such as https://en.anqicms.com/api/module/list

• Retrieve model details interface

  Retrieve detailed information about a specified content model, including basic information and custom field configurations, for dynamic form building and content management. Notes: This interface uses the GET method to obtain model information by model ID or model URL alias. It supports retrieving detailed information about both built-in and custom models. It returns the custom field list of the model for building dynamic forms. Model information includes field types, required or not, and other configuration information. Request address {domain address}/api/module/detail Note: {domain address}

• Get user shipping address interface

  Retrieve the shipping address information of the currently logged-in user, this interface will return the most recently used shipping address.Attention: This interface uses the GET method and no request body data is required. Access requires user login. Returns the most recently used shipping address information. If the user has no shipping address, returns empty data. Request address {domain_address}/api/order/address Note: {domain_address} needs to be replaced with your domain address, such as https://www.anqicms

• Save user shipping address interface

  Create or update the shipping address information for the user. Notes: This API uses the POST method and requires data to be submitted in application/ format. Access requires user login. If an ID parameter is provided, the existing address will be updated.Otherwise, create a new address All fields marked as required must be provided Request address {domain address}/api/order/address Note: {domain address} Replace it with your domain address, such as https://www.anqicms

• Cancel order interface

  Cancel the user-specified order and update the order status to cancelled.Note that this interface uses the POST method, data must be submitted in application/ format, requires user login to access, can only cancel orders belonging to the current user, and the order must be in a cancellable state to be canceled. Request URL {domain address}/api/order/cancel Note: {domain address} needs to be replaced with your domain address, such as https://www.anqicms

• Create order interface

  Create a user shopping order, support ordering a single item or multiple items, can specify delivery address, coupons and other information. Notes The interface uses the POST method, needs to be submitted in application/ format, requires user login to access, the order status is pending payment, waiting for user payment, can create an order through product ID or product detail list, supports using coupons and specifying a delivery address, request address {domain address}/api/order/create Note: {domain address} needs to be replaced with your domain address

• Order Details Retrieval Interface

  Get detailed information of the specified order, including order status, product information, shipping address, and complete order data.Note that this interface uses the GET method, no request body data is required, access requires user login, can only obtain order details belonging to the current user, returns complete order information, product details, and shipping address information, request address {domain address}/api/order/detail Note: {domain address} needs to be replaced with your domain address, such as https://www.anqicms

• Order confirmation receipt interface

  Allow users to confirm that the order has been received and update the order status to completed. Notes: This interface uses the POST method and requires data to be submitted in application/ format. The order ID is required as an identifier for confirming receipt. Only logged-in users can call this interface. The order must be in the 'Shipped' status to confirm receipt. After confirming receipt, the order status will change to 'Completed'. Request address {domain_address}/api/order/finish Description: {domain_address}

• Order Creation Payment Interface

  Create payment for pending orders, supporting multiple payment methods including WeChat, WeChat Mini Program, Alipay, PayPal, and Stripe. Notes The interface uses the POST method, data needs to be submitted in application/ format, order ID and payment method are required Only logged-in users can call this interface The order must be in the 'pending payment' status to create payment Payment information (QR code, jump link, or mini-program payment parameters) will be returned according to the different payment methods Request address

• Order application for refund interface

  Allow users to apply for a refund for completed or paid orders, after submitting a refund application, wait for the administrator to review and process. Notes This interface uses the POST method, needs to be submitted in application/ format, and needs to provide the order ID as the identifier for the refund application Only logged-in users can call this interface The order must be in the "completed" or "paid" status to apply for a refund After applying for a refund, the order status will change to "refund in progress"

• Order List Retrieval Interface

  Get the user's order list, support filtering by order status and pagination query.Attention: This interface uses the GET method, requires user login verification, supports filtering by order status (pending payment, paid, shipped, completed, etc.), supports pagination, the default number of items per page is determined by the pageSize parameter, and only returns the order information of the currently logged-in user. Request address {domain address}/api/orders Note: {domain address} needs to be replaced with your domain address, such as https://www.anqicms

• Check if the order has been paid interface

  Check the payment status of the specified order, confirm whether the order has been paid.Attention, this interface uses the GET method, requires an order ID parameter, requires user login verification (verification that the order belongs to the current user), returns the payment status information of the order, can only query the current user's own orders, request address {domain address}/api/payment/check Note: {domain address} needs to be replaced with your domain address, such as https://en.anqicms.com/api/payment/check

• Registration interface

  User registration interface, used to create a new user account. Notes The interface uses the POST method, requires data to be submitted in application/ format Supports multiple registration methods, can use username and password or mobile phone number verification code to register May require graphic captcha verification After successful registration, user information and login credentials are returned The username, email or mobile phone number must be unique The request address {domain address}/api/register Note: {domain address} needs to be replaced with your domain address, such as https://www

• Get distribution staff earnings list interface

  Get the retailer's profit list, support pagination query. Notes This interface uses the GET method, requires user login verification, only returns the profit records of the currently logged-in user, supports pagination query, can specify the current page number and number of items per page, including order amount, commission amount, withdrawal status information, request address {domain address}/api/retailer/commissions Note: {domain address} needs to be replaced with your domain address, such as https://www.anqicms

• Get distribution staff details interface

  Get detailed information of the specified distributor, including basic user information, distribution status, and user group information.Note that this interface uses the GET method, requires the distributor ID parameter, user login verification, returns the complete user information and group details of the distributor, including the distributor's cumulative earnings, invitation code, and other information, request address {domain address}/api/retailer/info Note: {domain address} needs to be replaced with your domain address, such as https://www.anqicms

• Get distribution team list interface

  Get the list of subordinates of the distributor's team members, supporting pagination search.Attention: This interface uses the GET method and requires user login verification (the current user must be a distributor). It only returns the member list of the current user's direct subordinates, supports pagination queries, and can specify the current page number and number of items per page. It returns the basic information and distribution status of the team members. Request address {domain address}/api/retailer/members Note: {domain address} needs to be replaced with your domain address, such as https://www.anqicms

• Get distribution order list interface

  Get the order list related to distributors, with pagination support.Attention: This interface uses the GET method and requires user login verification (the current user must be a distributor) to return a list of orders generated by the current distributor's promotion. It supports pagination queries and can specify the current page number and number of items per page. It includes detailed order information, buyer information, and product information. Request address {domain address}/api/retailer/orders Note: {domain address} needs to be replaced with your domain address, such as https://www.anqicms

• Get distribution staff statistics interface

  Get the distribution partner's statistics, including withdrawable commission, withdrawn commission, unsettled commission, and team size.Note that this interface uses the GET method, requires user login verification (the current user must be a retailer), no request parameters are needed, returns comprehensive statistics of the current retailer, including financial and team statistics information, request address {domain address}/api/retailer/statistics Note: {domain address} needs to be replaced with your domain address, such as https://www.anqicms

• Update the real name of the distribution staff interface

  Update the real name information of the retailer, used to modify the real-name authentication information of the retailer's account. Notes: This interface uses the POST method, requires data to be submitted in application/ format, and requires user login to call this interface. Only users with retailer status can update their real name. The update of the real name may require real-name authentication verification. Request address {domain address}/api/retailer/update Note: {domain address} needs to be replaced with your domain address, such as https://www

• Withdrawal Application Interface

  Submit the withdrawal application for distributors, transferring the account balance to the specified bank account or payment platform. Notes The interface uses the POST method and requires data to be submitted in application/ format The user must log in to call this interface The withdrawal amount must meet the minimum withdrawal amount set by the system The withdrawal application must be submitted and reviewed by the administrator The account balance must be sufficient and meet the withdrawal conditions The request address {domain address}/api/retailer/withdraw Notes: {domain address}

• Withdrawal list interface

  Retrieve the withdrawal application record list for distributors, supporting pagination query and status filtering. Notes The interface uses the GET method and requires user login to call the interface It only returns the withdrawal records of the currently logged-in user, supporting pagination query, defaulting to a fixed number of records per page Withdrawal records include different statuses: pending processing, approved, withdrawn, withdrawal error Request address {domain address}/api/retailer/withdraw Instructions: {domain address} needs to be replaced with your domain address, such as https://www

• Interface to Get Home Page TDK

  Retrieve the SEO information of the website homepage, including title (Title), keywords (Keywords), and description (Description) TDK configuration information. Notes The interface uses the GET method and can be accessed without logging in The interface returns the homepage SEO configuration information set by the website administrator in the background TDK information is used for SEO optimization, including homepage title, keywords, and description These information is usually used for the title of the browser tab and search engine display Request address {domain address}/api/setting/index note

• Get user details interface

  Get the basic information and account details of a specified user, including username, contact information, account status, balance, and other relevant user data.Note that this interface uses the GET method and requires the target user's ID to query user details. Depending on the user's permissions, you may only be able to view your own information or information of users you have permission to view. It returns the user's basic information and account-related information. Request address {domain address}/api/user/detail Note: {domain address} should be replaced with your domain address, such as https://www.anqicms

• Update user information interface

  Update the basic information of the currently logged-in user, including username, real name, personal introduction, email, and phone number, etc. Notes: This interface uses the POST method and requires data to be submitted in application/ format. The user must be logged in to call this interface. All parameters are optional, and only the fields that need to be updated can be updated. The username, email, and phone number may require uniqueness verification. After the update is successful, the operation result will be returned. Request address {domain address}/api/user/detail Note: {domain address}

• Get user group details interface

  Retrieve detailed information about a specified user group, including group name, level, price, configuration information, and other related user group data. Notes: This interface uses the GET method and requires the user group ID to query the group details. It returns the basic information and configuration information of the user group. The configuration information includes sharing profits, superior profits, discounts, and expiration days settings. It may require specific permissions to access certain group information. Request address {domain address}/api/user/group/detail Note: {domain address} needs to be replaced with your domain address, such as

• Get User Group List Interface

  Retrieve the list of all user groups in the system, including detailed information such as names, levels, prices, configurations, etc. Notes: This interface uses the GET method and can be accessed without logging in. It returns all available user group information in the system, including basic group information and configuration information. Configuration information includes settings such as sharing profits,上级收益, discounts, and expiration days. Request address {domain address}/api/user/groups Note: {domain address} needs to be replaced with your domain address, such as https://www

• Modify user password interface

  Modify the password of the currently logged-in user, it is necessary to verify the correctness of the original password before updating to a new password. Notes: This interface uses the POST method, data needs to be submitted in application/ format, the original password and new password need to be provided, the user must be logged in, and identity needs to be verified through session or Token, the new password must meet security requirements (such as length, complexity, etc.), it may be necessary to log in again after the modification is successful, the request address is {domain address}/api/user/password Description: {domain address}

• Generate Mini Program Code Interface

  Generate mini-program code (QR code) for quick access to a specified page in the mini-program, supporting scene parameters. Notes: This API uses the POST method and requires data to be submitted in application/ format. The mini-program path and scene parameters must be provided. The generated mini-program code can be used for sharing and promotion. Some parameters have length and format restrictions. Mini-program related information needs to be configured to use it normally. Request URL {domain address}/api/weapp/qrcode Note: {domain address} needs to be replaced with your domain address, such as

• WeChat official account service address interface

  The WeChat official account server configuration interface is used to receive and process messages and events sent by the WeChat server. Notes The interface uses GET and POST methods for WeChat server verification and message reception It is only used for WeChat official account server configuration and is not applicable to general API calls The interface address needs to be configured in the WeChat official account background The verification mechanism of the WeChat official needs to be implemented The interface needs to handle various messages and events sent by the WeChat server Request address {domain address}/api/wechat Note: {domain address} needs to be replaced with your domain address

• Official WeChat Authorization Interface

  The WeChat web page authorization login interface is used to implement user authorization login in the WeChat environment, supporting the retrieval of user basic information and the issuance of verification codes. Notes: This interface uses the GET method and is a redirect interface. It needs to be accessed in the WeChat built-in browser to work properly. It will first jump to the WeChat official authorization page, and return after user authorization. When the state parameter is code, a verification code will be sent to the user's WeChat. It is necessary to pre-configure the WeChat official account authorization callback domain. Request address {domain address}/api/wechat/auth Note: {domain address}

• Manual Sitemap Update Interface

  Manually trigger the system to regenerate the site map (Sitemap), supporting synchronous and asynchronous processing methods for updating search engine indexes. Notes This interface uses the POST method, submitting data in form-data format. An effective background import interface Token is required for authentication. Supports synchronous and asynchronous processing modes, asynchronous mode is suitable for sites with a large amount of content. Synchronous mode waits for the Sitemap generation to complete before returning the result. Asynchronous mode returns the processing result immediately, and the background continues to execute the generation task. Request address

• Import image resource interface

  Import image resources into the system, supporting functions such as specifying resource categories and replacing existing resources.This interface is mainly used for image upload and management in the background content management system.Attention. This interface uses the POST method, submits data in form-data format, requires a valid backend import interface Token for authentication, supports specifying the image resource category ID, supports replacing existing image resources (specified by ID), returns detailed information and access address after upload, request address {domain address}/attachment/upload

• Get favorite list interface

  Retrieve the current user's favorite list, supporting pagination queries, and returning all products or document information favorited by the user. Notes: This interface uses the GET method, and parameters are passed through the URL query string. Supports pagination queries, allowing specification of the current page number and the number of items per page. Only returns the current user's favorite records. Returns complete document information, including title, description, images, and other detailed content. Supports retrieving the price and inventory information of favorited products. Request address {domain address}/api/favorite/list Note: {domain address} needs to be replaced with your domain address

• Add favorite interface

  Add the specified product to the user's favorite list, supporting the specification of product SKU, suitable for the collection operation in e-commerce functions. Notes This interface uses the POST method, requires data to be submitted in application/ format, requires user login to operate, must specify product ID, can specify specific product specifications through SKU ID, if the product has already been collected, it will return the corresponding prompt information, request address {domain address}/api/favorite/add Description: {domain address}

• Remove favorite interface

  Remove the favorite record of a specified product or document, supporting the deletion of specific items from the user's favorite list. Notes: This interface uses the POST method and requires data to be submitted in application/ format. The document ID must be provided to specify the favorite item to be removed. Only logged-in users can remove their own favorite records. If the specified document is not favorited, a successful status is returned. After successful removal, it will no longer appear in the user's favorite list. Request URL {domain address}/api/favorite/delete Description: {domain address}

• Check if Favorited Interface

  Check if a specified product or document has been favorited by the current user, supporting single or batch query of favorite status. Notes The interface uses the POST method, requires data to be submitted in application/ format, and needs to provide document ID or an array of document IDs. Only logged-in users can query their own favorite status. Supports single document query and batch query. The returned favorite records include detailed information such as favorite time. Request address {domain address}/api/favorite/check Notes: {domain address}

• Product SKU Retrieval Interface

  Get the product SKU (stock keeping unit) information for the specified product, including product specifications, price, inventory, wholesale rules, and other detailed information.This API is suitable for scenarios that require displaying product specifications and purchase options.

• Interface to Update User Avatar

  Allow users to upload custom avatar images, supporting common image formats, used to update the avatar information in the user's personal profile. Notes This interface uses the POST method, requires data to be submitted in form-data format, requires the user to log in to call this interface, the uploaded file must be an image format (such as JPG, PNG, WEBP, etc.), file size and format may be limited, depending on the system configuration, after successful upload, the avatar of the currently logged in user will be automatically updated, request address {domain address}/api/user/avatar note

• Log out interface

  The user logs out, clears the current login status and session information, supports returning HTML pages or JSON data format.

• Send Email verification interface

  Send a verification email to the specified email address, which contains a verification link. The user clicks the link to complete the email verification. Notes The interface uses the POST method and requires data to be submitted in application/ format The interface is used to send a verification email to the specified email address The email contains a verification link, which the user clicks to complete the verification Supports various verification scenarios (email verification, password reset, etc.) A valid email address and verification status need to be provided The email sending is successful and a success message will be returned, but it is not guaranteed that the user will receive the email The request address

• Verify Email Address Interface

  Verify the validity of the email address, supporting email verification and password reset in various scenarios. Notes: This interface is used to verify the validity of the email address, supporting multiple verification scenarios (email verification, password reset, etc.). Ensures the validity of the request source through token and code parameters, supporting return of or html format data. After successful verification, the corresponding operation will be executed according to the state parameter. Ensure that the domain address is correctly configured. Request address {domain address}/api/verify/email Note: {domain address}

• Reset User Password Interface

  Reset user password through email verification, the user needs to provide the email address, new password, verification token and verification code. Notes The interface uses the POST method, and data needs to be submitted in application/ format Currently, the password can only be reset through email and needs to be used in conjunction with the email sending function The user needs to obtain the verification link first Provide the email sending verification token and code value The new password must meet the system password strength requirements Verification information has an expiration time limit, and a new verification email needs to be sent after expiration The request address

• Order Statistics Retrieval Interface

  Get the current user's order statistics, including the count of orders in various states.

• Get order statistics chart interface

  Get order statistics chart data, supporting query of historical trends by different order statuses.

• Product Checkout Information Retrieval Interface

  Retrieve product settlement information, supporting settlement of orders for a single product or multiple products, including discount calculations, address information, etc. Notes The interface uses the POST method, and data must be submitted in application/ format Supports placing an order for a single product (through goods_id, quantity, goods_sku_id parameters) or multiple products (through details parameters) Supports the use of coupons (coupon code or coupon ID) User login verification is required Supports setting the recipient's address and order notes Request address

• Get order address list interface

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

• Get wish list interface

  Retrieve the wish list list of the currently logged-in user, support pagination query, and return the user's favorite product information. Notes The interface uses the GET method and does not require a request body The user must be logged in, and identity verification is performed through session or Token Support pagination queries, which can be controlled by parameters to control the number of items displayed per page and the current page number Return detailed information about the products in the wish list, including price, notes, etc. Include the current price of the product and the price comparison when added Request address {domain address}/api/wishlist/list Note: {domain address}

• Add Wish List Interface

  Add the specified product to the user's wish list, supporting the setting of notes, price, priority, and other information. Notes: This interface uses the POST method and requires data to be submitted in application/ format. The product ID must be provided, and the SKU ID can be optionally provided. The user must be logged in, and identity is verified through session or Token. You can set the wish price, notes, and priority. If the product is already in the wish list, the existing record may be updated. Request address {domain address}/api/wishlist/add Description: {domain address}

• Remove Wish List Interface

  Delete the specified product record from the user's wish list. Notes: This interface uses the POST method and requires data to be submitted in application/ format. A wish list record ID must be provided. The user must be logged in and authenticated via session or Token. Only records belonging to the current user's wish list can be deleted. The deletion operation is irreversible and should be performed with caution. Request address {domain address}/api/wishlist/delete. Note: Replace {domain address} with your domain address, such as https

• Get available coupon list interface

  Retrieve the list of coupons available to the current user under the current situation, which supports filtering by order amount and product ID. Notes This interface is used to retrieve the list of coupons available to the current user. Coupons applicable to orders of specified amounts can be filtered through the amount parameter. Coupons applicable to specified products can be filtered through the archive_id parameter. It is necessary to log in to retrieve the coupon list. Ensure that the domain address is correctly configured. The returned coupons are valid and unused at the current time. The validity of the coupons includes time range, usage conditions, and other restrictions. Request address

• Get my coupons list interface

  Retrieve the current user's coupons list, supporting pagination display and status filtering. Notes This API is used to retrieve the current user's coupon list information, supporting pagination queries, which can be controlled by the current and pageSize parameters. Support filtering coupons by status (unused, used, or all). The user needs to log in to get the coupon list. Ensure that the domain address is correctly configured. The returned results include total count information for easy pagination processing. Request address {domain address}/api/coupon/codes description

• Redeem coupon interface

  Allow users to claim specified coupons by providing a coupon ID to obtain the coupon. Notes The interface uses the POST method, data needs to be submitted in application/ format A valid coupon ID needs to be provided Users must be logged in to claim coupons Coupons may have quantity limits or time limits The domain address needs to be correctly configured The same user may not be able to claim the same coupon twice Request address {domain address}/api/coupon/code Note: {domain address}

• Get shopping cart list interface

  API call address {domain address}/api/cart/list Description: {domain address} Replace it with your domain address, such as https://en.anqicms.com/api/cart/list Call method GET Header or Cookie Field name Type Required Description cart string No Used as user judgment token when not logged in Request parameters Field name Type Required Description current int

• Add shopping cart interface

  Add specified products to the shopping cart, supporting product SKU, quantity, and other information, suitable for shopping cart operations in e-commerce functions. Notes This interface uses the POST method and requires data to be submitted in application/ format It supports logged-in users and unlogged-in users (identified by cart token) Product ID and quantity must be specified Specific product specifications can be identified through SKU ID If the product is already in the shopping cart, the quantity will be updated instead of adding a new one Request address

• Remove shopping cart item interface

  Remove the specified item from the shopping cart, delete the corresponding shopping cart record based on the cart ID. Notes: This interface uses the POST method, requires data to be submitted in application/ format, and needs to provide the cart record ID instead of the product ID. It supports logged-in users and non-logged-in users (identified by cart token). After deletion, a success message is returned. Request address {domain address}/api/cart/remove Instructions: {domain address} needs to be replaced with your domain address, such as

• Update shopping cart interface

  API call address {domain address}/api/cart/update Note: {domain address} Replace it with your domain address, such as https://en.anqicms.com/api/cart/update Method POST Header or Cookie Field name Type Required Note cart string No Use this token to identify the user when not logged in Request parameters | Field name | Type | Required | Note

• Get communication customization order field interface

  Get information about the available custom fields for communication customization orders, which are used to provide form fields when creating communication customization orders.

• Get communication customization order list interface

  Retrieve the list of customized orders communicated by the user, with support for pagination.

• Create communication customization order interface

  Create a communication customization order, used for users to submit customization requirements, waiting for merchant confirmation. Notes The interface uses the POST method, needs to be submitted in application/ format, requires user login to access The created order needs to be confirmed by the merchant before entering the payment process The order status is pending confirmation, waiting for merchant acceptance Request address {domain address}/api/communication/order/create Note: {domain address} needs to be replaced with your domain address, such as https

• Get communication customization order details interface

  Get the detailed information of the customized communication order, including order status, communication records, etc.

• Update communication customized order interface

  Update the basic information of the customized communication order, including title, content, and additional order information. Notes The interface uses the POST method, and data must be submitted in application/ format Access requires user login Can only update orders belonging to the current user Order ID is required as a parameter to specify the order to be updated Request address {domain address}/api/communication/order/update Instructions: {domain address} Replace it with your domain address, such as https://www

• Communication customized order acceptance quote interface

  Caution: This interface uses the POST method, data needs to be submitted in application/ format, requires user login to access, the order status is pending payment, waiting for user payment, can be created by product ID or product detail list, this interface has the same parameters as the create order interface, specially used for accepting customized orders, request address {domain address}/api/communication/order/accept Note: {domain address} needs to be replaced with your domain address, such as https://www

• Retrieve Communication Custom Order Communication Information List Interface

  Get the communication record list of the specified customized order, supporting pagination query.

• Send Communication Custom Order Information Interface

  Send a message to the specified custom communication order, used for communication between users and administrators. Notes This interface uses the POST method, requires data to be submitted in application/ format, requires user login to access, can only send messages to orders belonging to the current user, supports various message types: text, images, quotes, videos, files, etc., request address {domain address}/api/communication/message/send Note: {domain address} needs to be replaced with your domain address, such as

• Get product/order evaluation list interface

  Get the product or order review list, supporting filtering and pagination by product, user, and other conditions.

• Post product/order evaluation interface

  Allow users to review purchased products or orders, supporting text reviews, ratings, and image uploads. Notes The API uses the POST method, requires data to be submitted in application/ format, and needs to provide the document ID and review content. Supports logged-in users and non-logged-in users (non-logged-in users need to provide a username). Can associate reviews with specific orders via order ID. Supports a 1-5 point rating system. Supports uploading multiple review images. Reviews need to be approved before they can be displayed. Request address

• Retrieve multilingual list interface

  Get the list of all available languages in the system, including language identifiers, icons, links, and so on, for the multi-language site switching function.