## 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
- 安全更新