PbootCMS API接口功能开发实操教程

本文由广东鲸弘科技有限公司提供惠州小程序开发 / 网站建设专业分享。

本文聚焦PbootCMS系统API接口功能，详细讲解接口开启配置、核心接口调用语法、实操步骤及常见问题，适配PbootCMS最新稳定版本，适合开发人员对接小程序、APP、第三方系统，也适合新手快速掌握API接口的使用方法，所有实操均基于官方默认配置，可直接复制测试。

一、PbootCMS API接口基础准备（必做）

PbootCMS内置完善的API接口体系，无需额外开发，只需完成基础配置即可开启接口调用，核心用于实现“数据互通”（如小程序获取网站文章、APP获取产品信息等），所有接口均遵循RESTful规范，支持GET/POST请求方式。

1.1 接口开启与基础配置

步骤1：登录PbootCMS后台，进入【系统设置】→【API接口设置】，勾选“开启API接口”，保存配置（默认关闭，开启后才能正常调用所有接口）。

步骤2：配置接口安全参数（关键，避免接口被恶意调用）：

• 接口密钥（api_key）：后台自动生成，可手动修改，调用接口时需携带该密钥，作为身份验证依据。

• IP白名单：可设置允许调用接口的IP地址，未在白名单内的IP会被拒绝访问（可选，推荐开启，提升安全性）。

• 请求频率限制：设置单位时间内的最大请求次数，防止接口被刷（可选，根据自身需求配置）。

注意1：接口密钥（api_key）不可泄露，一旦泄露需立即在后台重新生成，否则可能导致数据泄露或接口被恶意调用。

注意2：开启接口后，默认接口访问路径为：你的网站域名/api.php（核心路径，所有接口调用均基于此路径）。

1.2 接口调用通用规则

所有PbootCMS API接口均遵循以下通用规则，调用前需提前了解，避免出现调用失败：

1. 请求路径：统一为 https://你的网站域名/api.php（需替换为自身网站域名，http/https根据网站配置选择）。

2. 请求参数：所有接口均需携带「api_key」参数（后台获取），其余参数根据具体接口要求添加，参数传递支持GET（简单请求）和POST（复杂请求，如提交数据）。

3. 返回格式：默认返回JSON格式数据（包含code状态码、msg提示信息、data数据主体），便于前端解析。

4. 状态码说明（核心，用于排查调用错误）：

1. 200：请求成功，data为返回的具体数据。

2. 400：请求参数错误（如缺少api_key、参数格式错误）。

3. 403：权限不足（如api_key错误、IP不在白名单内）。

4. 404：接口不存在（请求路径错误或接口未开启）。

5. 500：服务器内部错误（需检查网站环境或接口配置）。

二、核心API接口实操（重点）

以下为PbootCMS最常用的API接口，涵盖“文章、栏目、产品、用户”四大核心场景，每个接口均包含「调用语法、参数说明、返回示例」，可直接复制测试，适配所有主流开发语言（PHP、Java、Vue、UniApp等）。

2.1 栏目列表接口（获取所有栏目数据）

用途：获取网站所有栏目信息（如栏目ID、栏目名称、栏目路径等），常用于小程序/APP的栏目导航。

（1）调用参数

（2）调用示例（GET请求）

https://www.xxx.com/api.php?api_key=abc123456789&action=categoryList&pid=1

（3）返回示例（JSON格式）

{
  "code": 200,
  "msg": "请求成功",
  "data": [
    {
      "cid": 2,
      "pid": 1,
      "name": "公司新闻",
      "url": "https://www.xxx.com/news/",
      "sort": 1,
      "status": 1,
      "addtime": "2026-01-01 10:00:00"
    },
    {
      "cid": 3,
      "pid": 1,
      "name": "行业动态",
      "url": "https://www.xxx.com/industry/",
      "sort": 2,
      "status": 1,
      "addtime": "2026-01-01 10:00:00"
    }
  ]
}

2.2 文章列表接口（获取栏目下的文章数据）

用途：获取指定栏目下的所有文章（如新闻、资讯），支持分页、排序，常用于小程序/APP的文章列表展示。

（1）调用参数

（2）调用示例（GET请求）

https://www.xxx.com/api.php?api_key=abc123456789&action=articleList&cid=2&page=1&num=5&order=desc

（3）返回示例（JSON格式）

{
  "code": 200,
  "msg": "请求成功",
  "data": {
    "total": 20, // 总文章数
    "page": 1, // 当前页码
    "num": 5, // 每页数量
    "list": [
      {
        "aid": 101,
        "cid": 2,
        "title": "PbootCMS API接口功能升级公告",
        "summary": "为提升接口稳定性，我们对API接口进行了全面升级...",
        "thumb": "https://www.xxx.com/upload/2026/04/10/123.jpg", // 文章缩略图
        "author": "管理员",
        "addtime": "2026-04-10 14:30:00",
        "url": "https://www.xxx.com/news/101.html" // 文章详情页地址
      },
      // 其余4条文章数据...
    ]
  }
}

注意：文章缩略图（thumb）字段，若后台未上传缩略图，返回值为空，前端可设置默认图片兜底。

2.3 文章详情接口（获取单篇文章完整数据）

用途：获取单篇文章的完整内容（标题、正文、缩略图、作者等），常用于小程序/APP的文章详情页。

（1）调用参数

（2）调用示例（GET请求）

https://www.xxx.com/api.php?api_key=abc123456789&action=articleInfo&aid=101

（3）返回示例（JSON格式）

{
  "code": 200,
  "msg": "请求成功",
  "data": {
    "aid": 101,
    "cid": 2,
    "title": "PbootCMS API接口功能升级公告",
    "summary": "为提升接口稳定性，我们对API接口进行了全面升级，优化了请求速度，增加了安全校验机制...",
    "content": "<p>尊敬的用户：</p><p>为提升接口稳定性，我们对PbootCMS API接口进行了全面升级，具体升级内容如下：</p>...", // 文章正文（HTML格式）
    "thumb": "https://www.xxx.com/upload/2026/04/10/123.jpg",
    "author": "管理员",
    "source": "官方公告",
    "addtime": "2026-04-10 14:30:00",
    "updatetime": "2026-04-10 15:00:00",
    "url": "https://www.xxx.com/news/101.html",
    "keywords": "PbootCMS,API接口,升级",
    "description": "PbootCMS API接口升级，提升稳定性和安全性..."
  }
}

注意：文章正文（content）返回的是HTML格式数据，前端需解析HTML后展示，避免直接输出导致格式错乱。

2.4 产品列表/详情接口（与文章接口用法一致）

PbootCMS产品接口与文章接口语法完全一致，仅需修改「action」参数，核心用于获取产品数据，适配产品展示场景：

• 产品列表接口：action=productList（参数与articleList一致，cid为产品栏目ID）

• 产品详情接口：action=productInfo（参数与articleInfo一致，aid为产品ID）

返回数据格式与文章接口一致，新增「price」（产品价格）、「spec」（产品规格）等产品专属字段，可直接参考文章接口用法调用。

2.5 用户登录接口（对接前端登录功能）

用途：实现前端（小程序/APP）用户登录，获取用户登录凭证（token），后续调用需要用户权限的接口时需携带该token。

（1）调用参数（POST请求，推荐，更安全）

（2）返回示例（JSON格式）

{
  "code": 200,
  "msg": "登录成功",
  "data": {
    "uid": 1001, // 用户ID
    "username": "testuser",
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...", // 登录凭证，有效期默认24小时
    "expire_time": "2026-04-11 14:30:00" // token过期时间
  }
}

注意1：用户登录接口推荐使用POST请求，避免密码明文暴露在URL中，提升安全性。

注意2：token过期后，用户需重新登录获取新的token，否则无法调用需要用户权限的接口（如用户个人中心接口）。

三、接口调用常见问题（避坑指南）

3.1 接口调用失败（返回403）

原因及解决方法：

• api_key错误：核对后台“API接口设置”中的api_key，确保调用时参数拼写正确，无多余空格。

• IP不在白名单：关闭IP白名单，或添加当前调用IP到后台白名单中。

• 接口未开启：进入后台“API接口设置”，确认已勾选“开启API接口”并保存。

3.2 接口返回数据为空（返回200，但data为空）

原因及解决方法：

• 参数错误：如cid错误（栏目不存在）、aid错误（文章/产品不存在），核对参数值是否正确。

• 数据未添加：后台对应栏目下未添加文章/产品，添加数据后重新调用。

• 分页参数错误：如page=10，但总页数只有5页，调整page参数至合理范围。

3.3 文章正文格式错乱

原因：文章正文（content）返回的是HTML格式，前端未解析HTML，直接输出纯文本。

解决方法：前端使用对应语言的HTML解析方法（如Vue的v-html、UniApp的rich-text组件），解析后再展示。

3.4 接口请求频率过高（返回429）

原因：后台设置了请求频率限制，单位时间内请求次数超过限制。

解决方法：调整后台“API接口设置”中的请求频率限制，或前端添加请求节流（如每秒最多请求1次）。

四、进阶扩展（可选）

1. 自定义API接口：若内置接口无法满足需求，可基于PbootCMS框架二次开发自定义接口，需熟悉PHP开发，修改系统核心文件（推荐在扩展目录开发，避免影响系统升级）。

2. 接口加密：除了api_key验证，可额外对请求参数进行MD5加密，提升接口安全性（后台可设置加密规则）。

3. 接口日志：开启后台“API接口日志”，可查看所有接口调用记录，便于排查错误（进入【系统设置】→【API接口设置】勾选“开启接口日志”）。

本文教程涵盖PbootCMS API接口核心用法，可直接用于开发对接，若需补充某类接口（如表单提交、留言接口）或细化某一步操作，可参考官方文档或留言咨询。