Get document details interface

API call address

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

illustrate:{域名地址}You need to replace it with your domain address, such ashttps://en.anqicms.com/api/archive/detail

Calling methods

GET

Request parameters

Field name	type	Required	illustrate
id	int	yes	Document ID, if filename is provided, ID is not required
filename	string	no	Document URL alias, either document ID or filename is required

Return parameters

Field name	type	illustrate
code	int	Error code
msg	string	Error Cause Description
data	object	Results content

data Parameters

Field name	type	illustrate
id	int	Document ID
title	string	Document title
seo_title	string	Document SEO title
url_token	string	Document URL Alias
keywords	string	Document keywords
Description	string	Document Introduction
module_id	int	Document Model ID
category_id	int	Document Category ID
views	int	Document view count
comment_count	int	Document comments
images	string[]	Document group photo
logo	string	Document Logo
thumb	string	Document thumbnails
flag	string	Document recommendation attributes, headlines[h]recommended[c]slide[f]special recommendation[a]scroll[s]bold[h]pics[p]jump[j]
canonical_url	string	canonical url
fixed_link	string	Document Permalink
created_time	int	Document release timestamp
updated_time	int	Document update timestamp
status	int	Document display status
user_id	int	User ID
price	int	Price, unit points
stock	int	Inventory quantity
user_id	int	User ID
category	object	Document classification information
data	object	Document content information
extra	object	Other fields information of the document

category Document Classification Information

Field name	type	illustrate
id	int	Category ID
parent_id	int	Category Parent ID
title	string	Category Name
seo_title	string	Category SEO Title
url_token	string	Category URL alias
keywords	string	Classification keywords
Description	string	Category Introduction
module_id	int	Model ID
content	string	Category content details
type	int	Classification attribute value, 1 category, 3 single pages
sort	int	Classification sorting values
images	string[]	Category Banner Image
logo	string	Classification thumbnails
thumb	string	Classification thumbnails
created_time	int	Document release timestamp
updated_time	int	Document update timestamp
status	int	Document display status

data Document Content Information

Field name	type	illustrate
id	int	Category ID
content	string	Document content details

extra document other field information

extra Displayed based on model settings, field structure is key => item: key is the field name, item is the content:

Field name	type	illustrate
name	string	Field name
value	string	The value filled in
default	string	default value

Request data example

parameter	value
id	1

Return to the data example

{
  "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

Error code	illustrate
0	OK
-1	Error, the error reason is indicated in msg
1001	Not logged in
1002	Unauthorized
200	API Request OK