OAuth 2.0プロトコル

概要

ログイン製品は、ユーザー登録と認証のためのOAuth 2.0標準プロトコルに対応しています。OAuth 2.0標準の認可プロトコルは、クライアントアプリケーションの開発容易性を重視し、ユーザーの参加なしにアクセストークンを更新することが可能です。OAuth 2.0プロトコルの詳細な情報は、その公式サイトで確認できます。ユーザーJWTはアクセストークンとして使用されます。

OAuth2.0クライアントとエクソーラログインサーバー間の相互作用を以下に示します：

OAuth 2.0プロトコルをセットアップするには：

1. ログイン製品を接続します。
2. エクソーラ、PlayFabまたはFirebaseストレージをセットアップします。
3. OAuth2.0クライアントを接続します。

OAuth 2.0クライアントを接続する

1. アドミンページでプロジェクトを開き、「ログイン」セクションに移動します。
2. ログインオプションのパネルにある「構成する」をクリックします。
3. 「セキュリティ」ブロックに移動し、「OAuth 2.0」セクションを選択します。

4. Add OAuth 2.0クライアントを追加するをクリックします。

5. モーダルウィンドウで、次のことを指定します：
   • クライアント名。
   • アカウントの確認、認証の成功、パスワードリセットの確認後にユーザーがリダイレクトされるURI（複数可）。
   • 認証タイプ：公開、機密、サーバー。

6. 接続をクリックします。

1. アプリケーションでOAuth 2.0認証をセットアップするために必要なクライアントIDと秘密鍵が生成されます。

7. ダイアログウィンドウで、コピーボタンを使ってクライアントIDと秘密鍵をコピーしてください。

OAuth 2.0クライアント設定を取得する

OAuth 2.0クライアント接続時にクライアントIDと秘密鍵をコピーしなかった場合、このデータにアクセスするために以下の操作が必要です：

1. アドミンページでプロジェクトを開き、「ログイン」セクションに移動します。
2. ログインオプションのパネルにある「構成する」をクリックします。
3. 「セキュリティ」ブロックに移動し、「OAuth 2.0」セクションを選択します。
4. 必要なOAuth2.0クライアントの行で：
   • 「クライアントID」フィールドの内容をコピーします。
   • 「クライアントキー」をクリックして、秘密鍵をコピーします。

クライアントIDと秘密鍵は、ログインAPIメソッドのclient_idとclient_secretパラメータに対応しています。OAuth 2.0クライアントを使用する場合は、これらの値を使用してください。

アプリケーション側での統合

以下の統合オプションが利用できます：

• ログインウィジェット経由
• ログインAPI経由
• Xsolla SDK経由

ログインAPIとログインウィジェットを使用する場合、scopeパラメータが使用されます。以下の値を取ります：

• offlineはアクセストークンを更新します。登録または認証メソッドにscope=offlineを渡します。
• emailはソーシャルネットワークを通じた認証の際に、ユーザーのメールアドレスをリクエストにします。ログイン製品をログインAPIで統合した場合、登録または認証メソッドにscope=emailを渡します。ログインウィジェットで統合する場合、メールアドレスと電話番号の収集に関する説明を使用して、ユーザーのメールアドレスの収集方法を設定します。

ログインウィジェット経由の統合

ログインウィジェット経由の統合を構成した場合、client_id、response_type、stateまたはredirect_uriパラメータを初期化コードに追加します。redirect_uriパラメータで、アドミンページでOAuth2.0クライアントに接続するときに設定された値を指定する必要があります。scopeパラメータを追加することもできます。

リクエストの例：

<script>
const xl = new XsollaLogin.Widget({
  projectId: 'LOGIN_PROJECT_ID',
  preferredLocale: 'en_US',
  clientId: 'CLIENT_ID',
  responseType: 'code',
  state: 'CUSTOM_STATE',
  redirectUri: 'REDIRECT_URI',
  scope: 'SCOPE'
});
</script>

ログインAPI経由の統合

OAuth 2.0プロトコルに対応したAPIメソッドを使用して、ユーザーの登録と認証を行います。すでにJWT規格のメソッドを統合している場合は、OAuth 2.0メソッドコールに置き換えてください。

認証メソッドを呼び出す際に、受信したcodeパラメータをアクセストークンと交換します。

エクソーラSDK経由の統合

• Unity（PC、ウェブ）
• Unreal Engine
• Cocos Creator

アクセストークンを取得する

ユーザーアクセストークンを取得するには、以下のパラメータ値でJWTを生成するメソッドを使用します：

• grant_typeの場合はauthorization_code；
• scopeの場合は（アクセストークンの次回更新時に必要です）offline；
• client_id — OAuth 2.0クライアント設定値；
• client_secret — OAuth 2.0クライアント設定値（公開OAuth 2.0クライアントでは不要です）；
• redirect_uri — アドミンページのOAuth 2.0クライアント接続時に設定された値；
• アプリケーションのユーザー認証または登録に成功した後に受け取たcode。

APIメソッドのレスポンスとして、以下のトークンが返されます：

• access_token — アクセストークン。デフォルトの有効期限は1時間です。
• refresh_token — リフレッシュトークンです。有効期限は限定されません。

リクエストの例：

POST https://login.xsolla.com/api/oauth2/token HTTP/1.1
Content-Type: application/x-www-form-urlencoded

client_id=11&client_secret=vGbXcsQ0CEW233m2qldYkd5IxbnRKoWt2YiBOgHYJGRGQwtIAdtxgxT64ik&code=ldYkd5IxbnRKoWt2YiBOgHYJGRGQwtIAdtxgxT64ik&grant_type=authorization_code&redirect_uri=https://my-website.com/callback

curl --request POST \
  --url https://login.xsolla.com/api/oauth2/token \
  --header 'content-type: application/x-www-form-urlencoded' \
  --data grant_type=authorization_code \
  --data client_secret=vGbXcsQ0CEW233m2qldYkd5IxbnRKoWt2YiBOgHYJGRGQwtIAdtxgxT64ik \
  --data client_id=11 \
  --data redirect_uri=https://my-website.com/callback \
  --data code=ldYkd5IxbnRKoWt2YiBOgHYJGRGQwtIAdtxgxT64ik

アクセストークンをリフレッシュする

アクセストークンの有効期限が切れたら、JWTを生成するメソッドを使用して、grant_typeパラメータをrefresh_tokenに等しくし、最後に受け取ったリフレッシュトークンの値（refresh_token）を使用してリフレッシュします。

APIメソッドのレスポンスとして、access_tokenアクセストークンとrefresh_tokenリフレッシュトークンの新しいペアが返され、その後再度リフレッシュすることができます。

リクエストの例：

POST https://login.xsolla.com/api/oauth2/token HTTP/1.1
Content-Type: application/x-www-form-urlencoded

client_id=11&client_secret=vGbXcsQ0CEW233m2qldYkd5IxbnRKoWt2YiBOgHYJGRGQwtIAdtxgxT64ik&grant_type=refresh_token&refresh_token=111dfgdfgdf&redirect_uri=https://my-website.com/callback

curl --request POST \
  --url https://login.xsolla.com/api/oauth2/token \
  --header 'content-type: application/x-www-form-urlencoded' \
  --data grant_type=refresh_token \
  --data client_secret=vGbXcsQ0CEW233m2qldYkd5IxbnRKoWt2YiBOgHYJGRGQwtIAdtxgxT64ik \
  --data client_id=11 \
  --data redirect_uri=https://my-website.com/callback \
  --data refresh_token=111dfgdfgdf