Third, Detailed Classification of API Interfaces

Here is the API interface classification provided by AnQiCMS, as well as some interface parameters. For more document interfaces and parameter configurations, please refer to the detailed documentation.

3.1 Content Management Interface

The Content Management Interface is used to handle the core content of the website, including documents, categories, tags, etc.

3.1.1Get Document Details Interface

  • Interface Path:/api/archive/detail
  • Request Method: GET
  • Function: Retrieve detailed information of a single document
  • Parameters:
    • id(int, Required) - Document ID
    • filename(string, optional) - Document URL alias (id/filename either)
    • render(boolean, optional) - Whether to render the content as HTML (Markdown document rendering), default is true

3.1.2Get Document List Interface

  • Interface Path:/api/archive/list
  • Request Method: GET
  • Function: Get the document list
  • Parameters:
    • moduleId(int, optional) - Model ID
    • categoryId(string, optional) - Category ID, multiple IDs can be separated by commas
    • limit(int, optional) - Display Quantity
    • page(int, optional) - Page number
    • order(string, optional) - Sorting method, such asid desc

3.1.3Retrieve document parameters interface

  • Interface Path:/api/archive/params
  • Request Method: GET
  • Function: Get custom document parameters
  • Parameters:
    • id(int, Required) - Document ID
    • filename(string, optional) - Document URL alias (id/filename either)
    • sorted(int, optional) - Return format, true for array format, false for object format

3.1.4Get category details interface

  • Interface Path:/api/category/detail
  • Request Method: GET
  • Function: Get detailed information of the category
  • Parameters:
    • id(int, optional) - Category ID
    • filename(string, optional) - Category URL alias

3.1.5Get category list interface

  • Interface Path:/api/category/list
  • Request Method: GET
  • Function: Get the category list
  • Parameters:
    • moduleId(int, optional) - Model ID
    • parentId(int, optional) - Parent category ID
    • limit(int, optional) - Display Quantity

3.1.6Get Tag List Interface

  • Interface Path:/api/tag/list
  • Request Method: GET
  • FunctionGet tag list
  • Parameters:
    • itemId(int, optional) - Document ID
    • letter(string, optional) - First letter filter
    • type(string, optional) - Return type

3.2 User Management Interface

The User Management Interface is used to handle user registration, login, information management, and other functions.

3.2.1User Login Interface

  • Interface Path:/api/login
  • Request Method: POST
  • FunctionUser login authentication
  • Parameters:
    • user_name(string, optional) - Username
    • password(string, optional) - Password
    • email(string, optional) - Email
    • phone(string, optional) - Phone number

3.2.2User Registration Interface

  • Interface Path:/api/register
  • Request Method: POST
  • Function: New user registration
  • Parameters:
    • user_name(string, optional) - Username
    • password(string, optional) - Password
    • email(string, optional) - Email
    • phone(string, optional) - Phone number
    • captcha(string, optional) - Verification code

3.2.3Get User Details Interface

  • Interface Path:/api/user/detail
  • Request Method: GET
  • Function: Get user details
  • Authentication required.: Yes

3.2.4User Favorite Management

  • Get Favorite List:/api/favorite/list
  • Add to Favorites:/api/favorite/add
  • Check favorite status:/api/favorite/check
  • Remove Favorite:/api/favorite/delete

3.3 Comment Interaction Interface

The Comment Interaction Interface is used to handle user comments and interaction features.

3.3.1Get Comments List Interface

  • Interface Path:/api/comment/list
  • Request Method: GET
  • Function: Get Comment List
  • Parameters:
    • archive_id(int, optional) - Document ID
    • parent_id(int, optional) - Parent Comment ID
    • limit(int, optional) - Display Quantity

3.3.2Post Comment Interface

  • Interface Path:/api/comment/publish
  • Request Method: POST
  • Function: Post Comment
  • Authentication required.: Yes
  • Parameters:
    • archive_id(int, Required) - Document ID
    • content(string, required) - Comment Content
    • parent_id(int, optional) - Parent Comment ID

3.4 Shopping Cart and Order Interface

The shopping cart and order interface is used to handle the product purchase process.

3.4.1Shopping cart management

  • Add to shopping cart:/api/cart/add
  • Get Shopping Cart List:/api/cart/list
  • Update shopping cart:/api/cart/update
  • Remove from shopping cart:/api/cart/remove

3.4.2Order Management

  • Create Order:/api/order/create
  • Get Order Details:/api/order/detail
  • Get Order List:/api/orders
  • Cancel Order:/api/order/cancel
  • Complete Order:/api/order/finished
  • Order Payment:/api/order/payment

3.5 Rating and Coupon Interface

3.5.1Rating Management

  • Release Order Review:/api/review/publish
  • Get order rating:/api/review/list

3.5.2Coupon Management

  • Get coupon code:/api/coupon/code
  • Get coupon list:/api//coupon/codes
  • Get valid coupon list:/api/coupon/valid

3.6 Distribution Interface

The distribution interface is used to handle related functions for distributors.

3.6.1Distributor Management

  • Get distributor details:/api/retailer/info
  • Update Distributor Information:/api/retailer/update
  • Get distributor statistics:/api/retailer/statistics

3.6.2Distribution revenue management

  • Get distributor earnings list:/api/retailer/commissions
  • Get distributor team list:/api/retailer/members
  • Get Distributor Order:/api/retailer/orders

3.6.3Distribution withdrawal management

  • Apply for Distributor Withdrawal:/api/retailer/withdraw
  • Get Distributor Withdrawal Record:/api/retailer/withdraw

System and Configuration Interface

The System and Configuration Interface is used to retrieve system settings and configuration information.

3.7.1System Settings

  • Get system settings:/api/setting/system
  • Get Contact Information:/api/setting/contact
  • Get home page settings:/api/setting/index
  • Get Custom Field:/api/setting/diy

3.7.2Other System Interfaces

  • Retrieve Multilingual Sites:/api/languages
  • Get Google URL:/api/google/url
  • Statistical Data:/api/log

3.8 Comment and Verification Interface

3.8.1Comment Management

  • Submit留言:/api/guestbook.html
  • Get Comment Field:/api/guestbook/fields

3.8.2Verification Management

  • Get captcha:/api/captcha
  • Send email verification:/api/verify/email
  • Verify Email:/api/verify/email

3.9Upload Interface

  • Upload Attachment Interface:/api/attachment/upload
  • Request Method: POST
  • FunctionUpload file attachment

3.10Document Import Interface

The document import interface is used to import content from third-party platforms.

  • Import documents:/api/import/archive
  • Check if the document exists:/api/import/archive/check
  • Get the document category list:/api/import/categories
  • Add友情链接:/api/friendlink/create
  • Check if the link exists:/api/friendlink/check
  • Delete Link:/api/friendlink/delete
  • Generate Sitemap:/api/import/sitemap

3.11WeChat Related Interfaces

  • WeChat API:/api/wechat
  • WeChat authorization API:/api/wechat/auth
  • Get Mini Program QR Code:/api/weapp/qrcode

3.12Other Interfaces

  • Subscription Interface:/api/subscription
  • Payment Check Interface:/api/payment/check
Search Outside Technology Security CMS
Privacy Terms 粤ICP备2024356999号 © 2020-2025 Shenzhen Souwai Technology Co., Ltd. All Rights Reserved, Created ByAnqi Content Management System (AnqiCMS)