API文档

接口使用声明

本平台提供的API接口完全免费开放使用，旨在为开发者提供便捷的数据获取服务。在使用本API时，请务必遵守以下条款：

免费使用：本API接口完全免费，不收取任何费用。
禁止商业牟利：严禁将本API接口用于任何形式的商业牟利行为，包括但不限于售卖数据、收费服务等。
严禁恶意请求：禁止进行恶意请求、高频刷取、爬虫攻击等行为，违者将封禁IP并追究法律责任。
注明来源：使用本API获取的数据时，请在页面或应用中明确标注数据来源为"浆果服友联"。
数据归属：本平台保留对API接口的最终解释权，如有疑问请联系管理员。

API接口文档

服务器列表分页查询

GET POST

获取浆果服服务器列表数据，支持分页查询和按类型筛选。注意：隐藏地址的服务器，paycontact字段将返回"服主隐藏服务器地址"。

接口地址

/api/servers.php?action=list

请求参数

参数名	类型	必填	说明
page	int	否	页码，默认1
size	int	否	每页数量，默认10，最大100
sort	string	否	排序方式：time（按时间，默认）、random（随机推荐）

返回示例

{
  "success": true,
  "data": [
    {
      "id": 1,
      "name": "我的服务器",
      "img": "https://example.com/upload/fwq/1/cover.png",
      "img2": "https://example.com/upload/fwq/1/view.png",
      "img3": "https://example.com/upload/fwq/1/play.png",
      "url": "BV1234567890",
      "paysketch": "服务器简介",
      "descriptison": "服务器详细描述",
      "version": "1.20.4",
      "money": "生存,创造",
      "paycontact": "192.168.1.1:25565",
      "sketch": "123456789",
      "type": "1",
      "source": "user_submit",
      "intime": "2024-01-01",
      "submit_time": "2024-01-01 12:00:00",
      "username": "用户名",
      "pageurl": "https://example.com/works.php?id=1"
    }
  ],
  "pagination": {
    "page": 1,
    "size": 10,
    "total": 100,
    "total_pages": 10
  }
}

字段说明

字段名	类型	说明
id	int	服务器ID
name	string	服务器名称
img/img2/img3	string	服务器图片完整URL（https://）
url	string	宣传视频BV号
paycontact	string	服务器IP地址（隐藏地址时返回"服主隐藏服务器地址"）
address_hidden	int	地址是否隐藏（1=隐藏，0=公开）
sketch	string	QQ群号
type	string	服务器平台：0-MCJPG，1-成员服，2-MSCPO，3-其他平台
source	string	服务器来源：user_submit-用户投稿，auto_collect-自动收录
pageurl	string	服务器详情页URL

服务器详情查询

GET POST

根据服务器ID获取已通过审核的服务器详细信息。注意：隐藏地址的服务器，paycontact字段将返回"服主隐藏服务器地址"。

接口地址

/api/servers.php?action=detail

请求参数

参数名	类型	必填	说明
id	int	是	服务器ID

返回示例

{
  "success": true,
  "data": {
    "id": 1,
    "name": "我的服务器",
    "img": "https://example.com/upload/fwq/1/cover.png",
    "img2": "https://example.com/upload/fwq/1/view.png",
    "img3": "https://example.com/upload/fwq/1/play.png",
    "url": "BV1234567890",
    "paysketch": "服务器简介",
    "descriptison": "服务器详细描述",
    "version": "1.20.4",
    "money": "生存,创造",
    "paycontact": "192.168.1.1:25565",
    "sketch": "123456789",
    "type": "1",
    "source": "user_submit",
    "intime": "2024-01-01",
    "submit_time": "2024-01-01 12:00:00",
    "username": "用户名",
    "pageurl": "https://example.com/works.php?id=1"
  }
}

服务器在线统计历史

GET

获取指定服务器近24小时的在线统计历史数据，用于绘制在线人数变化图表。

接口地址

/api/server_stats.php?action=history

请求参数

参数名	类型	必填	说明
server_id	int	是	服务器ID

返回示例

{
  "success": true,
  "data": {
    "server_id": 1,
    "server_name": "我的服务器",
    "is_show": 1,
    "stats": [
      {
        "time": "2024-01-01 10:00:00",
        "is_online": 1,
        "online_players": 25,
        "max_players": 100
      },
      {
        "time": "2024-01-01 10:15:00",
        "is_online": 1,
        "online_players": 30,
        "max_players": 100
      },
      {
        "time": "2024-01-01 10:30:00",
        "is_online": 0,
        "online_players": 0,
        "max_players": 0
      }
    ]
  }
}

字段说明

字段名	类型	说明
server_id	int	服务器ID
server_name	string	服务器名称
is_show	int	服务器显示状态（1=显示，0=隐藏）
stats	array	统计数据数组（近24小时，每15分钟一个点）
stats[].time	string	统计时间
stats[].is_online	int	在线状态（1=在线，0=离线）
stats[].online_players	int	在线玩家数量
stats[].max_players	int	最大玩家数量

错误返回

{
  "success": false,
  "message": "参数错误"
}

{
  "success": false,
  "message": "服务器不存在"
}

{
  "success": false,
  "message": "服务器已隐藏"
}

服务器实时状态查询

GET

获取指定服务器的实时在线状态、在线人数、MOTD和服务器图标等信息。注意：此接口不会暴露隐藏地址的服务器IP。

接口地址

/api/servers.php?action=status

请求参数

参数名	类型	必填	说明
id	int	是	服务器ID

返回示例

{
  "success": true,
  "data": {
    "id": 1,
    "name": "我的服务器",
    "server_status": "运行中",
    "online_count": 25,
    "max_players": 100,
    "motd": "A Minecraft Server",
    "pureMotd": "A Minecraft Server",
    "icon": "data:image/png;base64,...",
    "version": "1.20.4",
    "server_type": "JAVA",
    "status_img": "https://motd.minebbs.com/api/status_img?ip=192.168.1.1:25565&theme=simple",
    "address_hidden": 0
  }
}

返回字段说明

字段名	类型	说明
id	int	服务器ID
name	string	服务器名称
server_status	string	服务器状态：运行中/离线
online_count	int	当前在线玩家数
max_players	int	最大玩家数
motd	string/object	服务器MOTD（可能包含颜色代码）
pureMotd	string	纯文本MOTD（不含颜色代码）
icon	string	服务器图标（Base64编码）
version	string	服务器版本
server_type	string	服务器类型（JAVA/BE等）
status_img	string	服务器状态贴图链接（隐藏地址时返回空字符串）
address_hidden	int	地址是否隐藏（1=隐藏，0=公开）

批量服务器实时状态查询

GET POST

批量获取多个服务器的实时在线状态信息。适用于需要同时展示多个服务器状态的场景。注意：此接口不会暴露隐藏地址的服务器IP。

接口地址

/api/servers.php?action=status_batch

请求参数

参数名	类型	必填	说明
ids	string/array	是	服务器ID列表，多个ID用逗号分隔，或传递数组

请求示例

/api/servers.php?action=status_batch&ids=1,2,3

返回示例

{
  "success": true,
  "data": [
    {
      "id": 1,
      "name": "服务器A",
      "server_status": "运行中",
      "online_count": 25,
      "max_players": 100,
      "motd": "Welcome!",
      "pureMotd": "Welcome!",
      "icon": "data:image/png;base64,...",
      "version": "1.20.4",
      "server_type": "JAVA",
      "status_img": "https://motd.minebbs.com/api/status_img?ip=192.168.1.1:25565&theme=simple",
      "address_hidden": 0
    },
    {
      "id": 2,
      "name": "服务器B",
      "server_status": "离线",
      "online_count": 0,
      "max_players": 0,
      "motd": "",
      "pureMotd": "",
      "icon": "",
      "version": "",
      "server_type": "",
      "status_img": "",
      "address_hidden": 1
    }
  ]
}

注意事项

批量查询会对每个服务器进行状态检测，响应时间可能较长
建议单次查询不超过10个服务器
隐藏地址的服务器仍会返回在线状态，但不会暴露IP