PHP API框架 - 接口文档

1. 快速开始

调用所有接口需携带 key 参数（从管理员后台“接口Key管理”生成），支持两种传参方式：

1. URL参数：?key=你的64位接口Key
2. 请求头：X-API-Key: 你的64位接口Key

提示：Key无对应插件权限或已过期时，接口返回401/403错误，请联系管理员处理。

2. Demo插件接口（示例）

2.1 获取单条数据（GET）

请求方式：GET 接口功能：根据ID获取Demo表数据返回格式：JSON

示例URL：http://play.tengyuesj.cn/api/demo/getData?id=1&key=你的接口Key

请求参数

<

参数名 <	类型 <	是否必传 <	说明
id	int	是	数据ID（如1、2）
key	string	是	接口Key（64位字符串）

成功返回示例

{
    "code": 200,
    "msg": "success",
    "data": {
        "id": "1",
        "name": "测试数据1",
        "content": "demo插件的第一条数据",
        "create_time": "2025-01-01 10:00:00"
    }
}

2.2 获取分页列表（GET）

请求方式：GET 接口功能：获取Demo表分页数据返回格式：JSON

示例URL：http://play.tengyuesj.cn/api/demo/getList?page=1&size=10&key=你的接口Key

请求参数

<

参数名 <	类型 <	是否必传 <	说明
page	int	否	当前页（默认1）
size	int	否	每页条数（默认10，最大100）
key	string	是	接口Key（64位字符串）

成功返回示例

{
    "code": 200,
    "msg": "列表获取成功",
    "data": {
        "total": 2,
        "page": 1,
        "size": 10,
        "list": [
            {
                "id": "1",
                "name": "测试数据1",
                "content": "demo插件的第一条数据",
                "create_time": "2025-01-01 10:00:00"
            },
            {
                "id": "2",
                "name": "测试数据2",
                "content": "demo插件的第二条数据",
                "create_time": "2025-01-01 10:05:00"
            }
        ]
    }
}

3. 通用状态码说明

<

状态码 <	含义 <	常见场景
200	成功	数据查询成功、提交成功
400	参数错误	必传参数缺失、ID非数字、手机号格式错误
401	权限不足	未传Key、Key无效、Key已过期
403	访问拒绝	Key无插件权限、调用频率超限、IP被拉黑
404	资源不存在	查询的ID不存在、插件/接口不存在
500	服务器错误	数据库操作失败、代码逻辑错误