Interface to Get Product/Document Details

Retrieve detailed information about 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.

Points to note

• The interface supports retrieving document details through document ID or URL alias (filename) in two ways
• You can get the previous and next documents through this interface
• Some fields such as price, stock, and SKU are only valid in product type documents
• The response includes SEO-related fields for easy SEO optimization
• If the document does not exist, the interface will return an error code

Request address

{域名地址}/api/archive/detail

Description:{域名地址}Replace it with your domain name, such ashttps://en.anqicms.com/api/archive/detail

Request Syntax

GET {域名地址}/api/archive/detail?{参数}

Request Headers

This interface involves only public request headers. For more information, please refer toCommon Request Headers (Common Request Headers).

Request parameters

NoteThis interface can also retrieve the previous or next document of a specified document, the method of use is: when parameters id and filename are passed at the same time, the value of filename is prev/next, then the previous or next document is returned

Response header

This interface only involves common response headers. For more information, please refer toCommon Request Headers (Common Request Headers).

Return parameters

data document information

category document classification information

content document content information

Extra other fields information in the document

extra According to the model settings, the field display is, the field structure is key => item: key is the name of the form field, item is the content:

example of data request

GET /api/archive/detail?id=1 HTTP/1.1
Host: your-domain.com
Content-Type: application/json

or

GET /api/archive/detail?filename=anqicms HTTP/1.1
Host: your-domain.com
Content-Type: application/json

example of data return

{
  "code": 0,
  "data": {
    "id": 1,
    "created_time": 1607308159,
    "updated_time": 1662717106,
    "title": "欢迎使用AnqiCMS",
    "seo_title": "",
    "url_token": "anqicms",
    "keywords": "",
    "description": "欢迎使用AnqiCMS",
    "module_id": 1,
    "category_id": 1,
    "views": 1338,
    "comment_count": 0,
    "images": null,
    "status": 1,
    "canonical_url": "",
    "fixed_link": "",
    "flag": "",
    "user_id": 0,
    "price": 0,
    "stock": 9999999,
    "category": {
      "id": 1,
      "created_time": 1607308159,
      "updated_time": 1657761249,
      "title": "AnqiCMS帮助",
      "seo_title": "",
      "keywords": "",
      "url_token": "goruning",
      "description": "",
      "content": "<p>欢迎使用AnqiCMS</p>",
      "module_id": 1,
      "parent_id": 0,
      "type": 1,
      "sort": 1,
      "images": [],
      "logo": "https://en.anqicms.com/uploads/202012/7/bd36c37ef742c7be.webp",
      "status": 1,
      "thumb": "https://en.anqicms.com/uploads/202012/7/thumb_bd36c37ef742c7be.webp"
    },
    "data": {
      "id": 1,
      "content": "<p>欢迎使用AnqiCMS</p>"
    },
    "logo": "https://en.anqicms.com/uploads/202012/7/bd36c37ef742c7be.webp",
    "thumb": "https://en.anqicms.com/uploads/202012/7/thumb_bd36c37ef742c7be.webp",
    "extra": {
      "author": {
        "name": "作者",
        "value": "AnqiCMS",
        "default": ""
      }
    },
    "link": ""
  },
  "msg": ""
}

error code