コンテンツにスキップ

認証 API を使用してユーザー情報を取得

認証APIによるユーザー情報取得 は、ウェブログインを完了した後にユーザー情報を別途確認する必要がある場合にリクエストされるAPIです。

IdPに対応するユーザー情報を返します。これは、ログイン検証とユーザー情報取得 APIからの応答値 appididp_index、および idp_user_id を使用します。

リクエストURL

環境 URL
本番環境 https://auth.qpyou.cn/game/player/get-playerid
本番環境 https://auth.globalwithhive.com/game/player/get-playerid
サンドボックス https://sandbox-auth.qpyou.cn/game/player/get-playerid
HTTPメソッド POST
コンテンツタイプ application/json
Note

認証 v4 は、障害やネットワーク通信の問題が発生した場合に分散環境を作成するように設計されています。障害やネットワーク通信の異常がゲームサーバーのために定義された通信タイムアウトを超えた場合、分散環境の URL を呼び出す必要があります。

リクエストヘッダー

フィールド名 タイプ 説明 必須
ISCRYPT 整数 データが暗号化されているかどうか (0: 暗号化されていない) Y

リクエストボディ

フィールド名 タイプ 説明 必須
appid 文字列 アプリID Y
idp_index 整数 IdPインデックス
  • 1: Hive
  • 2: Facebook
  • 3: Google
  • 9: Apple
Y
idp_user_id 文字列 IdPユニーク識別子 Y
hive_certification_key 文字列 Hive認証キー (Hive Console > App Center > Project Management > Game Details > Basic Information > Hive Certification Key) Y

リクエストボディの例

{
  "appid": "com.com2us.hivesdk.normal.freefull.google.global.android.common",
  "idp_index": 1,
  "idp_user_id": "68101398",
  "hive_certification_key": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJIaXZlIiwiaWF0IjoxNjAyMDU2NzI2LCJqdGkiOiIxODczMTExMzIwIn0.3soFiHTPlObCoqR5xX9ZeOQTSvnHrHDHWmopP3QfWtY"
}

応答ボディ

フィールド名 タイプ 説明 備考
result_code 整数 結果コード
result_msg 文字列 結果メッセージ
data JSON 結果データ
data.enc_idp 文字列 リクエストボディ情報を暗号化するためのキー PCでの外部自動ログイン用のワンタイムトークン
data.player_id 大きな整数 プレイヤーID
data.list 配列 リンクされたIdPリスト ユーザーによってリンクされたIdPの情報を含むリスト
data.list.seq 大きな整数 リンクされたIdPリスト - シーケンス 認証時にのみ使用されるシーケンスキー
data.list.player_id 大きな整数 リンクされたIdPリスト - プレイヤーID
data.list.idp_user_id 文字列 リンクされたIdPリスト - IdPの一意の識別子
data.list.idp_index 整数 リンクされたIdPリスト - IdPインデックス
  • 1: Hive
  • 2: Facebook
  • 3: Google
  • 9: Apple
data.list.idp_id 文字列 リンクされたIdPリスト - IdP ID 他のIdPでプレイしてもGUESTはデフォルトで作成されます
data.is_blocked ブール値 ユーザーがブロックされているかどうか
  • true: ブロックされたユーザー
  • false: 通常のユーザー
data.is_refund ブール値 ユーザーが返金の再支払いの対象かどうか
  • true: 返金の再支払いの対象ユーザー
  • false: 返金の再支払いの対象でないユーザー

結果コード

result_code 説明
0 成功
2002 ユーザーデータなし
4000 無効なリクエストパラメータ

レスポンスボディサンプル (ユーザー情報が存在する)

{
  "result_code": 0,
  "result_msg": "SUCCESS",
  "data": {
    "enc_idp": "K+A4xduO7kf5OrJ/iDPqL0PtMxwu7wW8JSBO+JJwSDDmJLvIi/6LG7TyWXdEHr9RNHM+/QXwc0+Y9z2eSRg7oeBBHmpOajzF1iiaacbFom4CsNy2fItendset7T0i0WYdyLQih3z5mDjcct47+gg2ovbp6kWRY8D+aGq+ZgaKiyr0Hmb1xmbWY/7cl1FjXTm0Nl9CWhO418bJFdwOpi+bw==",
    "player_id": 20000016588,
    "list": [
      {
        "seq": 25771,
        "player_id": 20000016588,
        "idp_user_id": "68101398",
        "idp_index": 1,
        "idp_id": "HIVE"
      },
      {
        "seq": 25772,
        "player_id": 20000016588,
        "idp_user_id": "0",
        "idp_index": 0,
        "idp_id": "GUEST"
      }
    ],
    "is_blocked": false,
    "is_refund": false
  }
}

レスポンスボディサンプル(ユーザー情報なし)

{
  "result_code": 2002,
  "result_msg": "No User",
  "data": {
    "enc_idp": "K+A4xduO7kf5OrJ/iDPqLyCHfP+L3wz0WTNVw5KHLCqYjqQ+shQ2P3mkgwYCMvlnPatzlSE5ZFINr5gEIxK14sg0N8kOPSjSCeQ9UGGt11OMrYsGTuys0KmPJ2ZU/UWVVxpP1Lxx1eS8VbYwLmoTG+HTw2vkocghs/ZOZ9rqisdBRprhp6Q6+lIjpaUzDa2yy2guM1WheuVzKGL5331HHgo557RqoyUzTc6Lkf8ArWZ/XSwi3ZmStmhz/U4thcIwiowqgV+Ecdb2+WmMZ1MgGT4Xvbxa4lqzToBC3nxDvi1d8TjgMaszVYoNct94WPBGvV6emg3GqiJG+0ZTGg53+mZad9ttkUpTnQXetz5UDTxe5NnFAYfffzBq3jkqfAB042eH21rE3uTVJq3HuO8i9t1LJwKFfkC7sjjuaKNWsjs="
  }
}

レスポンスボディサンプル (失敗)

{
  "result_code": 4000,
  "result_msg": "Request has invalid format.",
  "data": "appid, idp_user_id, idp_index"
}