アカウントを削除する¶
特定のユーザーアカウントに関連付けられたPlayer IDを削除します。
アカウント削除APIは、アプリサーバーからHive認証サーバーに直接呼び出すサーバー間通信方式で動作します。リクエストが成功すると、そのプレイヤーIDのトークンとすべてのIdP(Identity Provider) 連動情報を削除します。削除後、そのアカウントで自動ログインまたはIdPログインを続行することはできません。
「アカウントの削除」機能で提供されるAPIは以下のとおりです。
- アカウントの削除(ログインステータス):
POST /v2/game/player/delete - アカウントの削除(ログイン不要):
POST /v2/game/player/delete-project
アカウントの削除(ログインステータス)¶
ユーザーがアプリにログインした状態で自分のアカウントを削除するときに使用します。
Request URL¶
リクエスト本文とレスポンスのデータ型はJSONです。使用する環境のURLに POST メソッドでリクエストしてください。
| 環境 | URL | HTTP Method | Content-Type |
|---|---|---|---|
| 商業 | https://auth.qpyou.cn/v2/game/player/delete | POST | application/json |
| Sandbox | https://sandbox-auth.qpyou.cn/v2/game/player/delete | POST | application/json |
Request header¶
Authorizationにはユーザートークンを、 X-Access-Tokenには、以下で説明するAccess Tokenを渡してください。 ISCRYPTは必ず 0に渡す必要があります。
| フィールド名 | 説明 | タイプ | 必須かどうか |
|---|---|---|---|
Authorization | アプリクライアントでログインが成功した後に返されたユーザートークン。 PlayerInfo.playerToken | String | Y |
X-Access-Token | ユーザー本人認証用のOAuth 2.0 Access Token。ログイン成功後に返された PlayerInfo.accessToken | String | Y |
ISCRYPT | データを暗号化するかどうか。 0は暗号化しないことを意味し、必ず 0に渡す | Integer | Y |
Request body¶
削除するアカウントのApp ID、DID(Instance ID)、Player IDを渡します。
| フィールド名 | 説明 | タイプ | 必須かどうか |
|---|---|---|---|
appid | App ID | String | Y |
did | DID(Instance ID) | Integer | Y |
player_id | Player ID | BigInteger | Y |
Response body¶
result_codeでアカウントの削除結果を確認してください。 JWT検証に失敗した場合 token_validationで詳細エラーを確認してください。エラーの意味は JWT検証エラーコードをご覧ください。
| フィールド名 | 説明 | タイプ | 場所 |
|---|---|---|---|
result_code | レスポンスコード | Integer | 応答本文 |
result_msg | 結果メッセージ | String | 応答本文 |
token_validation | JWT検証結果 (JWT検証エラー) | Object | 応答本文 |
token_validation.result_code | JWT検証結果コード | Integer | token_validation 子 |
token_validation.result_msg | JWT検証結果メッセージ | String | token_validation 子 |
レスポンスコード¶
検証または削除の結果に応じて、以下のコードを返します。
0: 成功2499:JWT検証に失敗しました。token_validation参考5000: サーバー内部エラー7000: 無効なトークン7001: 要求ヘッダーにトークン値がない
Request example¶
削除するアカウントを指定したリクエスト本文の例です。認証トークンと ISCRYPTはリクエストヘッダに別途含めてください。
{
"appid": "com.com2us.hivesdk.normal.freefull.apple.global.ios.universal",
"did": 225697886,
"player_id": 10000000445
}
Response example¶
アカウントの削除が成功したかどうかの応答の例です。
成功¶
アカウントの削除に成功したレスポンスの例です。
{
"result_code": 0,
"result_msg": "SUCCESS",
"token_validation": {
"result_code": 0,
"result_msg": "success"
}
}
JWT検証失敗¶
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."
}
}
アカウントの削除(ログイン不要)¶
ユーザーがログインしていない状態でアカウントを削除するときに使用します。アプリサーバー認証用のOAuth 2.0 Access TokenであるProject JWTとユーザートークンで認証します。この方法も Authorizationに PlayerInfo.playerTokenを渡す必要があります。
Request URL¶
リクエスト本文とレスポンスのデータ型はJSONです。使用する環境のURLに POST メソッドでリクエストしてください。
| 環境 | URL | HTTP Method | Content-Type |
|---|---|---|---|
| 商業 | https://auth.qpyou.cn/v2/game/player/delete-project | POST | application/json |
| Sandbox | https://sandbox-auth.qpyou.cn/v2/game/player/delete-project | POST | application/json |
Request header¶
Authorizationにはユーザートークンを、 X-Access-Tokenには、以下で説明するAccess Tokenを渡してください。 ISCRYPTは必ず 0に渡す必要があります。
| フィールド名 | 説明 | タイプ | 必須かどうか |
|---|---|---|---|
Authorization | アプリクライアントでログインが成功した後に返されたユーザートークン。 PlayerInfo.playerToken | String | Y |
X-Access-Token | アプリサーバー認証用のOAuth 2.0 Access Token。 OAuth Tokenを発行する 参考 | String | Y |
ISCRYPT | データを暗号化するかどうか。 0は暗号化しないことを意味し、必ず 0に渡す | Integer | Y |
Request body¶
削除するアカウントのApp ID、DID(Instance ID)、Player IDを渡します。
| フィールド名 | 説明 | タイプ | 必須かどうか |
|---|---|---|---|
appid | App ID | String | Y |
player_id | Player ID | BigInteger | Y |
did | DID(Instance ID) | Integer | Y |
Response body¶
result_codeでアカウントの削除結果を確認してください。 JWT検証に失敗した場合 token_validationで詳細エラーを確認してください。エラーの意味は JWT検証エラーコードをご覧ください。
| フィールド名 | 説明 | タイプ | 場所 |
|---|---|---|---|
result_code | レスポンスコード | Integer | 応答本文 |
result_msg | 結果メッセージ | String | 応答本文 |
token_validation | JWT検証結果 (JWT検証エラー) | Object | 応答本文 |
token_validation.result_code | JWT検証結果コード | Integer | token_validation 子 |
token_validation.result_msg | JWT検証結果メッセージ | String | token_validation 子 |
レスポンスコード¶
検証または削除の結果に応じて、以下のコードを返します。
0: 成功2499:JWT検証に失敗しました。token_validation参考5000: サーバー内部エラー7000: 無効なトークン7001: 要求ヘッダーにトークン値がない
Request example¶
削除するアカウントを指定したリクエスト本文の例です。認証トークンと ISCRYPTはリクエストヘッダに別途含めてください。
{
"appid": "com.com2us.hivesdk.normal.freefull.apple.global.ios.universal",
"player_id": 100000001,
"did": 225697886
}
Response example¶
アカウントの削除が成功したかどうかの応答の例です。
成功¶
アカウントの削除に成功したレスポンスの例です。
{
"result_code": 0,
"result_msg": "SUCCESS",
"token_validation": {
"result_code": 0,
"result_msg": "success"
}
}
JWT検証失敗¶
JWT の有効期限が切れて検証に失敗した応答の例です。