停止中のゲームサーバーを登録します
利用停止ゲームサーバー登録¶
利用停止ゲームサーバー登録APIは、利用停止ユーザーの情報を登録または変更する際に、その情報をゲームサーバーへ自動で伝達する機能を提供します。このAPIを通じて、ゲームサーバーで利用停止ユーザー情報をリアルタイムに受信できます。
- 情報伝送時間: 停止されたユーザー情報が新たに登録または変更されると、自動的にゲームサーバーに送信されます。停止が解除されると、情報はAPIを介して送信されません。
- 情報伝送単位: 最大100件の停止されたユーザー情報が1回のリクエストで送信されます。例えば、2,000件の停止されたユーザーがいる場合、100件ずつ分けて20回のリクエストがゲームサーバーに送信されます。
利用停止ゲームサーバー登録APIを使用するには、リクエスト(Request)を受け取れるようにゲームサーバーを準備する必要があります。ゲームサーバー登録はHiveコンソールで以下のパスから設定できます。
- パス: Hiveコンソール > 認証 > 利用停止 > ゲームサーバー登録
基礎¶
| 説明 | |
|---|---|
| Request URL | Hiveコンソールのゲームサーバーに登録したプロジェクトのゲームサーバーURL: [Hiveコンソール > 認証 > 利用停止 > ゲームサーバー登録] |
| HTTPメソッド | POST |
| コンテンツタイプ | application/json |
| データ形式 | JSON |
| 認証 | Bearer ゲームサーバー認証キー |
Note
- Bearerトークンは[Hiveコンソール 認証 > 利用停止 > ゲームサーバー登録 > プロジェクト詳細 > ゲームサーバー認証キー]に該当します。
- ゲームサーバー認証キーの検証は、要求されたゲームサーバーで検証できるように開発されなければなりません。
リクエスト¶
| 名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
| game_index | 整数 | O | ゲームインデックス |
| server_url | 文字列 | O | ゲームサーバーのURL |
| data | List | O | 利用停止ユーザー一覧 |
| data.player_id | 整数 | O | プレイヤーID |
| data.status | String | O | 利用停止状態 P: 永久利用停止 B: 利用停止期間があるユーザー |
| data.start_date | 文字列 | O | 停止開始日 |
| data.end_date | 文字列 | O | 停止終了日 |
応答¶
| 名前 | タイプ | 説明 | ノート |
|---|---|---|---|
| result_code | 整数 | 結果コード | * 0: 通常 * その他のすべてのコードはエラーです（ゲームサーバーから応答されたコード） |
リクエストの例¶
curl -X POST {URL of the game server of the project registered to the Hive console game server}
-H 'Content-Type: application/json'
-H 'Authorization: Bearer {Game server authentication key issued when registering the Hive console game server}'
-d '{"game_index": 539, "server_url": "{URL of the game server of the project registered to the Hive console game server}", "data": [{"player_id": 1, "status": "B", "start_date": "2024-07-10 20:56:59", "end_date": "2024-07-13 20:56:59"}, {"player_id": 2, "status": "B", "start_date": "2024-07-10 20:56:59", "end_date": "2024-07-20 20:56:59"}, {"player_id": 3, "status": "P", "start_date": "2024-07-10 20:56:59", "end_date": "9999-12-31 00:00:00"}]}'
リクエストJSONの例¶
{
"game_index": 539,
"server_url": "{URL of the game server of the project registered in the Hive console game server}",
"data": [
{
"player_id": 1,
"status": "B",
"start_date": "2024-07-10 20:56:59",
"end_date": "2024-07-13 20:56:59" }, { "player_id": 2, "status": "B", "start_date": "2024-07-10 20:56:59", "end_date": "2024-07-20 20:56:59" }, { "player_id": 3, "status": "P", "start_date": "2024-07 -10 20:56:59", "end_date": "9999-12-31 00:00:00" } . . .
(Up to 100 suspended users sent. EX) If 2,000 suspended users are registered, a total of 20 game server transmission requests will occur, 100 each.)
]
}