利用停止の登録および解除¶

This API registers a user account as suspended on the Hive server or releases it according to the app operation policy.

API Endpoint	説明
`POST /v2/game/block/set`	Register access restriction
`POST /v2/game/block/delete`	Release access restriction

ゲームサーバー送信

Hiveコンソール > 認証 > 利用停止 > ゲームサーバー登録にゲームサーバーが登録されている場合、このAPIで利用停止を登録または解除すると、該当情報がゲームサーバーへ自動で伝達されます。詳しくは利用停止通知ゲームサーバー登録を参照してください。

Register access restriction¶

If restriction types are registered in advance through Hive Console or the Register restriction type API, you can distinguish permanent restrictions from time-limited restrictions and change restriction information for an existing user identified by PlayerID.

リクエストURL¶

本番URL	https://auth.qpyou.cn/v2/game/block/set
サンドボックスURL	https://sandbox-auth.qpyou.cn/v2/game/block/set
HTTPメソッド	POST
Content-Type	application/json
データ形式	JSON

リクエストヘッダー¶

フィールド名	説明	タイプ	必須
X-Access-Token	アプリサーバー認証用のOAuth 2.0 Access Token (OAuth Tokenを発行するを参照)	String	Y
ISCRYPT	データ暗号化の有無（0 = 暗号化しない）（必ず0を送信）	Integer	Y

リクエスト本文¶

フィールド名	説明	タイプ	必須
appid	App ID	String	Y
player_id	Player ID	Integer	Y
status	Suspension status `P`: Permanent suspension `B`: User with a suspension period	String	Y
block_type	Restriction type number Must be registered first in [Hive Console > Authentication > Restriction > Type registration] or through the Register restriction type API.	Integer	Y
start_date	Suspension start date (format: `YYYY-MM-DD HH:mm:ss`)	String	Y
end_date	Suspension end date (format: `YYYY-MM-DD HH:mm:ss`)	String	Y
skip_blocked	If requested as `true` and blocking data already exists, returns `result_code=0` without changing the blocking data.	Boolean	N
did	App identifier created when the app is installed. It identifies the same type of app. Passing a newly issued or existing value returned during SDK initialization verifies the login history on that device.	Integer	N

リクエスト例¶

To register a time-limited restricted user, set status to B and send start_date and end_date together.

{"appid":"com.com2us.hivesdk.normal.freefull.apple.global.ios.universal","player_id":24000000000,"status":"B","block_type":18,"start_date":"2024-06-03 00:00:00","end_date":"2024-06-30 23:59:59","skip_blocked":true,"did":2000000}

レスポンス本文¶

フィールド名	説明	タイプ
result_code	レスポンスコード詳細	Integer
result_msg	結果メッセージ	String
token_validation	JWT検証結果（JWT検証エラー）	Object
token_validation.result_code	JWT検証結果コード	Integer
token_validation.result_msg	JWT検証結果メッセージ	String

レスポンスコード¶

Code value	説明
0	成功
2499	JWT検証失敗（token_validationを参照）
4000	無効なパラメータ The format of the suspension start or end date is invalid The start date is later than the end date The current time is later than the end date
4011	Unregistered type
4013	`did` login history verification failed (cannot verify while logged out)
6000	無効なappid

レスポンス例¶

成功¶

{"result_code":0,"result_msg":"SUCCESS","token_validation":{"result_code":0,"result_msg":"success"}}

Release access restriction¶

Directly releases a specific account from its suspended state on the Hive server.