跳转至

封禁 API 指南

根据您的操作政策,我们提供了一项功能,可以在 Hive 服务器上设置账户暂停。通过在 Hive 控制台中预先注册暂停类型,您可以区分并注册永久暂停的用户和具有临时暂停期限的用户。此外,您可以更改已注册用户(按 PlayerID 区分)的暂停类型和暂停期限。

基础

请求 URL
  • 生产环境: https://auth.qpyou.cn/game/block/set
  • 沙盒环境: https://sandbox-auth.qpyou.cn/game/block/set
方法 POST
HTTP 头
  • 内容类型: application/json
  • ISCRYPT: 0
响应格式 JSON

请求

参数 类型 必需 描述
appid 字符串 应用ID
player_id 整数 玩家 ID
hive_certification_key 字符串 认证密钥(由应用中心颁发)
status 字符串 暂停状态
  • `P`: 永久暂停
  • `B`: 有暂停期限的用户
block_type 整数 封禁类型编号
必须先在 [Hive 控制台 > 认证 > 封禁 > 类型注册] 中完成注册。
start_date 字符串 暂停开始日期
end_date 字符串 暂停结束日期
skip_blocked Boolean X 如果请求时设置 skip_blocked=true,当已存在封禁数据时,将不会更改封禁数据,并返回 result_code=0
did Integer X 这是在安装游戏应用时生成的游戏应用标识符。用于识别同一类型的游戏应用。在 SDK 初始化时,如果传递新签发或已存在并返回的值,将验证该设备的登录记录。

响应

参数 类型 描述
result_code 整数 结果代码
  • 0: 成功
  • 4000: 无效参数
    • 如果暂停开始日期和结束日期的格式不正确
    • 如果开始日期晚于结束日期
    • 如果当前时间晚于结束日期
  • 4002: 认证密钥不匹配
  • 4011: 未注册类型
  • 4013: did 登录记录验证失败
    • 在登出状态下无法验证
  • 6000: 无效的appid
result_msg 字符串 关于暂停原因的结果消息

注册限期封禁请求示例

注册限期封禁用户时,请将 status 设为 B,并同时传递 start_dateend_date

curl -X POST https://auth.qpyou.cn/game/block/set \
-H 'Content-Type: application/json' \
-H 'ISCRYPT: 0' \
-d '{"appid" : "com.com2us.hivesdk.normal.freefull.apple.global.ios.universal", "player_id" : 24000000000, "hive_certification_key" : "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJIaXZlIiwiaWF0IjoxNjAyMDU2NzI2LCJqdGkiOiIxODczMTExMzIwIn0.3soFiHTPlObCoqR5xX9ZeOQTSvnHrHDHWmopP3QfWtY", "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_code0result_msgSUCCESS

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

解除用户的暂停

直接在 Hive 服务器上解除特定账户的暂停。

基础

请求 URL
  • 生产环境: https://auth.qpyou.cn/game/block/delete
  • 沙盒环境: https://sandbox-auth.qpyou.cn/game/block/delete
方法 POST
HTTP 头
  • Content-type: application/json
  • ISCRYPT: 0
响应格式 JSON

请求

字段 类型 必需 描述
appid 字符串 应用ID
player_id 整数 玩家ID
hive_certification_key 字符串 认证密钥(在应用中心颁发)

响应

字段 类型 描述
result_code 整数
  • 0: 成功
  • 2002: 用户未被暂停
  • 4000: 无效参数
  • 4002: 认证密钥不匹配
  • 6000: 无效的appid
result_msg 字符串 结果消息

解除封禁请求示例

解除特定账号的封禁时,请按以下请求格式同时传递 appidplayer_idhive_certification_key

curl -X POST https://auth.qpyou.cn/game/block/delete \
-H 'Content-Type: application/json' \
-H 'ISCRYPT: 0' \
-d '{"appid" : "com.com2us.hivesdk.normal.freefull.apple.global.ios.universal", "player_id" : 24000000000, "hive_certification_key" : "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJIaXZlIiwiaWF0IjoxNjAyMDU2NzI2LCJqdGkiOiIxODczMTExMzIwIn0.3soFiHTPlObCoqR5xX9ZeOQTSvnHrHDHWmopP3QfWtY"}'

解除封禁成功响应示例

请求处理成功时,返回 result_code0result_msgSUCCESS

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