自訂認證金鑰核發¶
發出在應用程式中連結自訂 IdP(身分提供者)所需的身份驗證金鑰。 「發布自訂身份驗證金鑰」API 透過伺服器到伺服器通訊進行操作,其中應用程式伺服器直接呼叫 Hive 身份驗證伺服器。呼叫成功後,自訂身份驗證金鑰將在回應的 data.custom_auth_key 欄位中傳回。您可以使用此密鑰新連結 IdP 或將 IdP 連結到玩家 ID。
請求網址¶
| 生產網址 | https://auth.qpyou.cn/v2/game/customauth/get-key |
|---|---|
| 沙箱網址 | https://sandbox-auth.qpyou.cn/v2/game/customauth/get-key |
| HTTP 方法 | POST |
| Content-Type | application/json |
| 資料格式 | JSON |
| ## 請求頭 | |
| 欄位名稱 | 描述 |
| --- | --- |
| X-Access-Token | 用於遊戲伺服器驗證的 OAuth 2.0 存取權杖 (請參閱 OAuth 權杖核發) |
| ISCRYPT | 資料是否加密(0 = 未加密;始終傳遞 0) |
| ## 請求正文 | |
| 欄位名稱 | 描述 |
| --- | --- |
| appid | 應用程式 ID |
| idp_id | IdP 的字串值 |
| idp_user_id | IdP 提供的使用者 ID 值 |
| auth_type | 自訂驗證金鑰的用途 SIGNINIDP:新的 IdP 連結與驗證 CONNECT:將 IdP 連結到玩家 ID |
| player_id | 用戶玩家 ID |
Note
在這些欄位中,idp_id 值必須以下面範例中所示的指定字串格式之一寫入。
- 自訂_火力基地
- 自訂_FACEBOOK
- 自訂_GOOGLE
- 自訂_SIGNIN_APPLE
- 自訂_推特
- 自訂_NAVER
- 自訂遊戲
響應體¶
| 欄位名稱 | 描述 | 類型 |
|---|---|---|
| result_code | 回應代碼 詳情 | Integer |
| result_msg | 回覆留言 | String |
| token_validation | JWT 驗證結果 (JWT 驗證錯誤) | Object |
| token_validation.result_code | JWT驗證結果碼 | Integer |
| token_validation.result_msg | JWT 驗證結果訊息 | String |
| data | 回應資料 | Object |
| data.custom_auth_key | 自訂驗證金鑰 | String |
回應碼¶
| 代碼值 | 描述 |
|---|---|
| 0 | 成功 |
| 1005 | 不支援的 auth_type |
| 2499 | JWT 驗證失敗(請參閱 token_validation) |
| 4200 | 不受支援的 IdP |
請求範例¶
{
"appid": "com.com2us.hivesdk.normal.freefull.apple.global.ios.universal",
"idp_id": "CUSTOM_TWITTER",
"idp_user_id": "1204273895139753984",
"auth_type": "SIGNINIDP",
"player_id": 10012038880
}
回應範例¶
成功¶
{
"result_code": 0,
"result_msg": "SUCCESS",
"token_validation": {
"result_code": 0,
"result_msg": "success"
},
"data": {
"custom_auth_key": "f28ac8415716f438b9c972e3706c0dab"
}
}
JWT 驗證失敗¶
{
"result_code": 2499,
"result_msg": "JWT validation failed. See token_validation for details.",
"token_validation": {
"result_code": 2408,
"result_msg": "The access token is expired. Please refresh your token."
}
}
Note
當JWT驗證失敗時,您可以透過token_validation欄位查看詳細的錯誤訊息。詳細資訊請參閱JWT 驗證錯誤代碼。