Other commonly used interfaces

AnqiCMS other commonly used API interfaces, including: add friend link interface, delete friend link interface, get friend link list interface, get comment list interface, publish comment interface, like comment interface, get message form field interface, add message interface, get system settings interface, get contact information interface, get navigation list interface, upload image resource interface, call captcha interface

• 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

• 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

• 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

• 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}

• 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.

• Statistics page visit data

  API call address {domain address}/api/log Note: {domain address} You need to replace it with your domain address, such as https://en.anqicms.com/api/log html The template will inject by default.If it is a next.js frontend, then you need to call it yourself.

• Email Subscription Interface

  Submit your email address to subscribe to the website's latest news, updates, or other email content. Notes: This interface uses the POST method and requires data to be submitted in application/ format. A valid email address is required. It supports adding remarks and categories for subscribers. After successful subscription, the user will receive an email confirmation or be directly added to the subscription list. The email address must be validated for format. Request address {domain_address}/api/subscription Note: {domain_address} needs to be replaced with your domain address.

• Interface for getting customized content

  Retrieve the content parameters for custom settings on the website backend, used to obtain various parameter information configured by the administrator in the backend. Notes: This interface uses the GET method and can be accessed without logging in. It returns the configuration parameters of the custom content settings of the website administrator. The custom parameters are determined by the backend settings and may include various custom fields. The names and content of the custom parameters are determined by the website administrator in the backend. Request URL {domain address}/api/setting/diy Note: {domain address} needs to be replaced with your domain address, such as

• Interface Document of Page Metadata

  Interface overview This interface is used to retrieve metadata information of the corresponding page based on the page path (URI), helping Next.js dynamic routing to determine which specific backend interface should be requested.