遊戲面板
取得線上玩家列表、傳送全服公告、踢出或封鎖玩家、儲存、重新啟動等操作，都可以使用遊戲面板的 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）」。
- 請依用途分別使用金鑰，不再需要時及時刪除。萬一外洩，刪除後即刻失效。
- 您無法存取沒有權限的伺服器。
