## API
CMS內容管理系統提供了一個基礎API接口,僅限用于數據遷移或內部接口,不建議用于對接外部API接口。
## 準備工作
使用API接口之前,請務必在后臺->`CMS管理`\->`站點配置`中設置`API密鑰`,設定密鑰后才可以調用API接口。
## 新增文檔
用于新增文檔
### 請求URL
http://www.yoursite.com/addons/cms/api/index
### 請求方法
POST
### 請求參數
| **Body參數名** | 類型 | 必需 | 描述 | 示例 |
| --- | --- | --- | --- | --- |
| title | string | 是 | 標題 | 標題 |
| apikey | string | 是 | API密鑰值,可以從后臺CMS管理站點配置`API密鑰`中獲取 | 無 |
| status | string | 是 | 狀態:normal=可見,hidden=隱藏 | normal |
| tags | string | 是 | 標簽,Test,自定義 | a,b,c |
| content | string | 是 | 內容,支持HTML | 測試內容 |
| channel | string | 是 | 分類名稱 | 分類一 |
| user | string | 是 | 發布會員,會員的昵稱 | Admin |
| price | string | 是 | 付費價格 | 0 |
| flag | string | 是 | 標志:index=首頁,hot=熱門,recommend=推薦 | |
| views | string | 是 | 瀏覽次數 | 1000 |
| createtime | string | 是 | 添加時間,也可以是時間戳 | 2019-10-01 00:00:00 |
| user\_id | string | 否 | 發布會員ID,如果有傳user,則優先user | 1 |
| channel\_id | string | 否 | 發布會員ID,如果有傳channel,則優先channel | 1 |
| 副表字段1 | string | 否 | 副表字段名稱,副表字段必須和欄目的模型字段相匹配 | author |
| 副表字段n | string | 否 | 副表字段名稱,副表字段必須和欄目的模型字段相匹配 | author |
### 返回值
~~~css
{
"code":"1",
"msg":"新增成功"
}
~~~
## 讀取文檔
根據文檔ID查詢文章信息
### 請求URL
http://www.yoursite.com/addons/cms/api/archives
### 請求方法
POST
### 請求參數
| **Body參數名** | 類型 | 必需 | 描述 | 示例 |
| --- | --- | --- | --- | --- |
| id | string | 是 | 文檔ID | 1002 |
| apikey | string | 是 | API密鑰值,可以從后臺CMS管理站點配置`API密鑰`中獲取 | 無 |
### 返回值
~~~javascript
{
"code":"1",
"msg":"讀取成功",
"data":{
"id":"1002",
"title":"這是一篇測試文章",
......
//其它fa_cms_archives表和副表的字段
}
}
~~~
## 讀取文檔列表
根據模型ID和欄目ID查詢文章列表
### 請求URL
http://www.yoursite.com/addons/cms/api/arclist
### 請求方法
POST
### 請求參數
| **Body參數名** | 類型 | 必需 | 描述 | 示例 |
| --- | --- | --- | --- | --- |
| apikey | string | 是 | API密鑰值,可以從后臺CMS管理站點配置`API密鑰`中獲取 | 無 |
| model | int | 是 | 模型ID | 1 |
| channel | int | 是 | 欄目ID | 1 |
| page | int | 是 | 當前頁 | 1 |
| pagesize | int | 是 | 分頁大小 | 10 |
### 返回值
~~~javascript
{
"code":"1",
"msg":"讀取成功",
"data": [
{
"id":"1002",
"title":"這是一篇測試文章",
......
//其它fa_cms_archives表的字段
},
{
"id":"1003",
"title":"這是一篇測試文章",
......
//其它fa_cms_archives表的字段
}
]
}
~~~
## 獲取欄目列表
用于獲取系統的欄目列表
### 請求URL
http://www.yoursite.com/addons/cms/api/channel
### 請求方法
POST
### 請求參數
無
### 返回值
~~~css
{
"code": 1,
"msg": "讀取成功",
"data": {
"14": "網絡工具",
"13": "媒體工具",
"12": "應用軟件",
"10": "智能家居",
"9": "移動設備",
"8": "智能設備",
"6": "硬件",
"5": "投資",
"4": "安全",
"3": "互聯網"
}
}
~~~
## 新增評論
用于寫入文章評論
### 請求URL
http://www.yoursite.com/addons/cms/api/comment
### 請求方法
POST
### 請求參數
| Body參數名 | 類型 | 必需 | 描述 | 示例 |
| --- | --- | --- | --- | --- |
| apikey | string | 是 | API密鑰值,可以從后臺CMS管理站點配置`API密鑰`中獲取 | 無 |
| type | string | 是 | 類型,page=單頁,archives=文檔 | page |
| content | string | 是 | 評論內容 | 測試評論內容 |
| aid | string | 是 | 單頁或文檔ID | 1 |
| user\_id | string | 是 | 會員ID | 1 |
| token | string | 是 | 會員的Token | von3nso2lnfdsfsdnfdsoi23 |
### 返回值
~~~css
{
"code": 1,
"msg": "新增成功",
}
~~~
## 新增自定義表單數據
用于寫入自定義表單數據
### 請求URL
http://www.yoursite.com/addons/cms/api/diyform
### 請求方法
POST
### 請求參數
| Body參數名 | 類型 | 必需 | 描述 | 示例 |
| --- | --- | --- | --- | --- |
| apikey | string | 是 | API密鑰值,可以從后臺CMS管理站點配置`API密鑰`中獲取 | 無 |
| diyform\_id | string | 是 | 自定義表單ID | 1 |
| 自定請表單字段1 | string | 是 | 字段1 | 數據1 |
| 自定請表單字段n | string | 是 | 字段1 | 數據n |
| user\_id | string | 否 | 會員ID,只在自定義表單需要登錄時傳入 | 1 |
| token | string | 否 | 會員的Token,只在自定義表單需要登錄時傳入 | von3nso2lnfdsfsdnfdsoi23 |
### 返回值
~~~css
{
"code": 1,
"msg": "數據提交成功",
}
~~~
## 溫馨提示
該API接口僅限用于數據遷移或內部接口,不建議用于對接外部API接口
該API接口不支持跨域訪問,如需跨域訪問,需要自行對`addons/cms/controller/Api.php`二次開發,添加跨域的檢測方法。
- 概述
- 安裝
- 配置
- 模板
- 標簽
- 全局標簽
- 文檔/文檔列表
- 專題/專題列表
- 欄目/欄目列表
- 公共參數
- 單頁/單頁列表
- 特殊標簽
- 欄目列表頁
- 分頁標簽
- 自定義字段
- ThinkPHP5標簽
- 自定義表單數據列表
- 自定義過濾條件
- 用戶信息
- 模板目錄
- API
- 小程序
- 控制器
- Archives.php
- Base.php
- Common.php
- Index.php
- My.php
- User.php
- 準備工作
- 導入項目
- 修改配置
- 測試數據
- 多語言
- 常見問題
- Uniapp版
- 1.準備工作
- 1.HbuilderX安裝
- 2.Hbuilder 插件安裝
- 2.導入項目
- 3.運行項目
- 1.運行前的配置
- 2.運行為H5
- 3.運行為微信小程序
- 4.運行為APP
- 4.項目發布
- 1.發布H5端
- 2.發布微信小程序
- 3.發布APP
- 5.登錄配置
- 6.常見問題
- 1.關于自定義導航欄切換閃爍問題
- 2.關于后臺移動端樣式預覽問題
- 3.關于支付配置的問題
- 4.前端跨域的問題
- 5.關于各端內容分享的問題
- 6.關于簽到問題
- 7.關于公眾號授權登錄問題
- 8.關于底部導航的追加或刪除問題
- 9.運行微信小程序,進入微信小程序客戶端后,沒有底部菜單
- 10.關于首頁焦點圖的修改
- 11.關于發布小程序代碼大小超出的問題
- 12.前端顯示空白或白屏或提示網絡請求錯誤的問題
- 13.關于如何在非tabbar配置頁面顯示tabbar導航
- 14.關于更換資訊頁為主頁的問題
- 15.關于更新1.4.4版本分包問題
- 16.Tabbar底部高亮顯示問題
- 17.微信小程序獲取手機號失敗
- 18.微信小程序從頁面側滑返回或按鍵返回時Tabbar丟失的問題
- 19.Tabbar底部不支持外部鏈接的修復方法
- API文檔
- 公共接口(Common)
- 文檔接口(Archives)
- 評論接口(Comment)
- 自定義表單(Diyform)
- 短信驗證碼(Sms)
- 郵箱驗證碼(Ems)
- 登錄/注冊(Login)
- 我的接口(My)
- 搜索文檔(Search)
- 標簽文檔(Tag)
- 日志中心(TheLogs)
- 會員中心(User)
- 專題接口(Special)
- 功能解說
- 自動內鏈
- 自定義表單
- 區塊管理
- 欄目管理
- 模型管理
- 偽靜態
- Sitemap
- 安全更新