游戏面板
获取在线玩家列表、发送全服公告、踢出或封禁玩家、保存、重启等操作，都可以使用游戏面板的 API 从您自己的程序中执行。本页将介绍从创建 API 密钥到读取命令执行结果的完整方法。
本页可以实现的操作
使用游戏面板的 API（客户端 API），可以从您自己的程序或脚本中自动执行以下操作：
- 获取当前在线的玩家列表
- 发送全服公告
- 踢出或封禁玩家
- 手动保存
- 启动·停止·重启服务器
- 获取运行状态（CPU·内存·磁盘·流量）
该 API 适用于所有游戏。各游戏特有的命令，请参阅对应游戏的文档。
创建 API 密钥
- 登录游戏面板，从右上角的账户菜单打开 「API Credentials（API 凭据）」。
- 填写便于识别用途的说明并创建。
- 保存所显示的密钥。
密钥仅在创建后显示一次。关闭页面后将无法再次显示，请务必在此时妥善保存。
请在 「Allowed IPs（允许的 IP）」 中填写调用 API 的设备或 VPS 的固定 IP 地址，这样密钥便只能从该地址使用。若留空则可从任何位置使用，因此如果您拥有固定 IP，请务必设置。
每个账户最多可创建 25 个密钥。请按用途分别创建，并删除不再需要的密钥。
基本用法
基础 URL 如下：
https://gsv.bestnetllc.co.jp/api/client请求需附带以下标头：
Authorization: Bearer <API 密钥>
Accept: application/json
Content-Type: application/json ← POST 时服务器标识符是在面板中打开服务器时地址 https://gsv.bestnetllc.co.jp/server/xxxxxxxx 的末尾 8 个字符。
主要接口
| 服务器列表 | GET /api/client | |
| 发送命令 | POST /api/client/servers/{id}/command | 正文 {"command":"..."} / 成功返回 204 |
| 启动·停止·重启 | POST /api/client/servers/{id}/power | 正文 {"signal":"start"}（stop / restart / kill） |
| 状态·资源 | GET /api/client/servers/{id}/resources | 状态·CPU·内存·磁盘·流量·运行时长 |
| 控制台连接信息 | GET /api/client/servers/{id}/websocket | 读取执行结果时使用（见 05） |
发送命令的示例：
curl -X POST "https://gsv.bestnetllc.co.jp/api/client/servers/xxxxxxxx/command" \
-H "Authorization: Bearer ptlc_xxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"command":"Info"}'读取命令的执行结果
POST /command 仅返回 204 No Content，执行结果不包含在响应正文中。即使发送不存在的命令也会返回 204。204 表示「命令已送达控制台」，并不代表执行成功。如需读取执行结果，请连接控制台（WebSocket）。
- 调用
GET /api/client/servers/{id}/websocket，将返回连接地址（socket）与token。 - 使用 WebSocket 连接该
socket。 - 连接后首先发送
{"event":"auth","args":["<token>"]}。收到{"event":"auth success"}即认证完成。 - 此后控制台输出会以
{"event":"console output","args":["..."]}的形式传来。 - 您也可以在同一连接上发送
{"event":"send command","args":["..."]}。
由于发送与接收可在一条连接上完成，推荐使用第 5 种方式。这是最接近 RCON 的用法。
token 的有效期为 10 分钟。长时间连接时，请重新从 websocket 接口获取 token 并再次发送 {"event":"auth","args":["<新 token>"]}。连接目标并非面板域名，而是服务器所在节点的主机名（端口 8443）。这属于正常现象。
限制与注意事项
- 请求限制为每分钟 256 次。该限制按账户计算，更换来源 IP 也无法放宽。
- 在服务器停止状态下发送命令会返回错误（
Server must be online in order to send commands.）。 command为空时会返回输入错误（422）。- 您发送的命令会记录在面板的活动日志中。
- 如需让子用户使用，需要「控制台操作」权限。
关于安全
- API 密钥请与密码同等对待。请勿将其放入 GitHub、Discord 或截图中。
- 请设置「Allowed IPs（允许的 IP）」。
- 请按用途分别使用密钥，不再需要时及时删除。万一泄露，删除后即刻失效。
- 您无法访问没有权限的服务器。
