• バージョン： 1.0.0
• サーバー：https://login.xsolla.com/api
• プロトコル：https
• 承認：application / json
• 応答：application / json
• メールでお問い合わせください
• 連絡先URL： https://xsolla.com/

このセクションでは、ログイン を操作するための API 呼び出しについて説明します。リクエストを送信する前に、パブリッシャー アカウント でログイン プロジェクトを セットアップ してください。

API定義を2つの形式でダウンロードできます：

• YAML
• JSON

アドミンページでは、次のログインプロジェクトタイプにアクセスできます：

• 標準ログインプロジェクト
• シャドウログインプロジェクト

詳細については、クロスプラットフォームアカウント機能を参照してください。

メインアカウントを保存するために使用されるログインプロジェクトです。

プラットフォームアカウントを保存するために使用されるログインプロジェクトです。

標準ログインプロジェクトで作成され、プラットフォームアカウントにリンクされているアカウントタイプです。メインアカウントは、異なるプラットフォームでプレーヤーを識 別するために使用されます。

シャドウログインプロジェクトで作成され、確定したパブリッシングプラットフォームに接続されるアカウントタイプです。プラットフォームアカウントは、他のプラットフォー ムアカウントとリンクすることはできません。また、メインアカウントからアカウントのリンクを解除することもできません。

ゲームの配布に使用されるゲームプラットフォームです（Steam、PlayStation、Xboxなど）。

Login APIは、以下のトークンタイプをサポートしています：

• ユーザートークン。これは、以下のユーザーリソースにリクエストを送信するために使用されます：
  • プロフィール
  • 友達
  • 属性
• サーバートークン。設定やユーザーデータなど、アプリケーションリソースへのリクエストを送信するために使用されます。以下のリクエストが利用可能です：
  • プラットフォームアカウントを作成する
  • ユーザーデータを取得する
  • アカウントをリンクする
  • external ID経由でユーザーIDをリンクする

トークンを取得するには、次のいずれかのリクエストを送信します：

• ユーザー登録（JWTまたはOAuth 2.0）
• ユーザー名とパスワード経由の認証（JWT、OAuth 2.0、またはユーザー名とパスワード経由のJWT認証）
• ソーシャルネットワーク経由の認証（JWTまたはOAuth 2.0）
• サイレント認証（JWTまたはOAuth 2.0）
• ソーシャルネットワークアクセストークン経由の認証
• パブリッシングプラットフォーム経由の認証

JWT認証後、ユーザーはクエリパラメータにトークンを含むコールバックURLにリダイレクトされます：<Callback URL>?token=<User token (JWT)>。

OAuth 2.0プロトコルベースの認証後、JWTを生成するリクエストをエクソーラログインサーバーに送信して、受信したcodeパラメータをユーザートークン（access_token）と交換します。

サーバートークンを取得するには：

1. サーバーOAuth 2.0クライアントをセットアップする。
2. サーバーJWTを生成する。

サーバーOAuth 2.0クライアントをセットアップする

1. パブリッシャーアカウントでプロジェクトを開き、ログインセクションに移動します。
2. ログインプロジェクトのパネルで構成をクリックします。
3. セキュリティブロックに移動し、OAuth 2.0セクションを選択します。
4. Click Add OAuth 2.0 Client.
5. **サーバー (server-to-server connection)**ボックスのチェックを入れます。
6. トークンの有効期間を指定します。
7. 接続をクリックします。
8. クライアントIDと秘密キーをコピーして保存します。

サーバーJWTを生成

アプリケーションのバックエンドで、JWT APIを生成するコールを使用してサーバーJWTを取得するメソッドを実装します。リクエストには次のパラメータが含まれている必要があります。

• grant_type is the type of getting JWT, pass the client_credentials value.
• client_secret is the secret key that is received when you set up the server OAuth 2.0 client.
• client_id is the client ID received when you set up the server OAuth 2.0 client.

すべてのトークンにはJWTフォーマットがあり、ペイロードに明確な情報が含まれています。

ユーザーJWTは、認証または登録の結果として受け取ったトークンです。トークンのペイロードには、ユーザーと認証のコールに関する情報が含まれています。

OAuth 2.0プロトコルでユーザートークンを取得するには、OAuth 2.0クライアントが必要です。ユーザートークンは、Authorization: Bearer <JWT>ヘッダで渡されます。

トークンには、認証またはメールアドレス確認後の主な要求が含まれます。これらの要求の有無は、ユーザーデータベースや認証コールに依存しません。

 

クレーム	タイプ	必須	説明
exp	Unixタイムスタンプ	はい	トークンの有効期限を設定する日時。デフォルトの有効期限は24時間です。有効期限は、ログインプロジェクトごとに変更できます。
iss	文字列	はい	トークンに署名したサービス：https://login.xsolla.com。
iat	Unixタイムスタンプ	はい	トークンを発行した日時。
sub	文字列（UUID）	はい	エクソーラログインサーバー側に書き込まれたユーザーID。
groups	配列	はい	ユーザーが所属しているグループのリスト。各グループは以下のフォーマットで書かれます： id — グループID name — グループ名 is_default — グループがデフォルトであるかどうかを示します（trueまたはfalseの値）。 デフォルトグループは1つしか存在できません。このグループには、異なるグループに分散される前のすべてのユーザーが初期状態で含まれています。
xsolla_login_project_id	文字列（UUID）	はい	ログインプロジェクトID。
type	文字列		認証オプション： xsolla_login — ユーザー名/メールアドレスとパスワードによるログイン。 social — ソーシャルログイン email — 電子メールで受信したワンタイムコードによるパスワードレスログイン。 phone — SMS経由で受信したワンタイムコードによるパスワードレスログイン。 firebase — ユーザーデータストレージがFirebaseの場合、ユーザー名/メールアドレスとパスワードでログインします。 playfab — ユーザーデータストレージが PlayFabの場合、ユーザー名/メールアドレスとパスワードでログインします。 proxy — ユーザーデータストレージがproxyの場合、ユーザー名/メールアドレスとパスワードでログインします。 device — デバイスIDでログインします。 server_custom_id — カスタムIDを使用してログインします。 デフォルトグループは1つしか存在できません。このグループには、異なるグループに分散される前のすべてのユーザーが初期状態で含まれています。
avatar	文字列		ユーザーのアバターURL。
username	文字列		ユーザー名。
publisher_id	integer		ログインプロジェクトを所有するマーチャントのID。
email	文字列		ユーザーのメールアドレス。
payload	文字列		認証時にペイロードパラメータで渡される追加情報。
promo_email_agreement	ブール型		次のいずれかの値になります： true ユーザーがニュースレターの受信に同意した場合。 false それ以外の場合。 デフォルトはtrueの値になります。 ログインウィジェットの登録フォームに機能を追加するには： Widget 2.0を使用している場合は、アカウントマネージャーまでお問い合わせください。 旧バージョンのウィジェットを使用する場合は、初期化コードにpromo_email_agreement値を持つfieldsパラメータを追加してください。
connection_information	文字列		ユーザーが生年月日を確認したかどうかを表示します。確認はoknameサービスを通じて行われます。

PlayFabストレージを使用する場合、認証後にトークンに含まれる要求。

クレーム	タイプ	必須	説明
external_account_id	文字列	はい	ユーザーPlayFab ID。
session_ticket	文字列	はい	PlayFab APIへの認証リクエストまたはリクエストの間に受け取ったSessionTicketパラメータです。 OAuth 2.0プロトコルを経由でユーザーを認証し、playfab値をscopeパラメータに渡す場合、トークンには要求が含まれます。
entity_token	文字列	はい	EntityToken.EntityTokenパラメータ。
entity_type	文字列	はい	EntityToken.Entity.Typeパラメータ。 title_player_accountの値のみを持つことができます。
entity_id	文字列	はい	EntityToken.Entity.Idパラメータ。

カスタムストレージを使用する場合、認証後にトークンに含まれる要求。

クレーム	タイプ	必須	説明
provider	文字列	はい	認証に使用されるソーシャルネットワークの名前。ユーザーがユーザー名とパスワード経由で認証する場合、要求にはxsolla値が含まれます。
external_account_id	文字列		サーバー側のユーザーID。
partner_data			認証時にサーバーからレスポンスボディに返される任意のタイプのデータ。

ソーシャルネットワーク経由の認証後、トークンに含まれる要求。これらの要求の存在は、ユーザーデータベースに依存しません。

クレーム	タイプ	必須	説明
provider	文字列	はい	認証に使用されるソーシャルネットワークの名前。
id	文字列	はい	ソーシャルネットワークにおけるユーザーID。
is_cross_auth	ブール型		サイレント認証のリクエストが進行中であることを示します。
social_access_token	文字列		認証に使用するソーシャルネットワークアカウントのaccess_tokenパラメータ。この機能をセットアップするには、アカウントマネージャーにお問い合わせください。
picture	文字列（URL）		ソーシャルネットワークにおけるユーザープロフィール画像へのリンク。
birthday	日付（RFC3339）		ソーシャルネットワークにおけるユーザーの誕生日。
gender	文字列		ソーシャルネットワークにおけるユーザー性別。
name	文字列		ソーシャルネットワークにおけるユーザーニックネーム。

OAuth 2.0認証後のトークンに含まれる要求。

クレーム	タイプ	必須	説明
jti	文字列	はい	一意のトークンID。

電話番号経由の認証後、トークンに含まれる要求。

クレーム	タイプ	必須	説明
phone_number	文字列	はい	認証に使用されるユーザーの電話番号。電話番号は、国番号、市外局番、回線番号からなる区切りのない形式です。

サーバートークンは、X-SERVER-AUTHORIZATIONヘッダーで渡されます。

トークンのペイロードには、OAuth 2.0クライアントが所有するリソースに関する情報が含まれています。トークンは、これらのリソースに対するサーバーベースの認証によるコールにアクセスできます。

クレーム	タイプ	必須	説明
xsolla_login_project_id	文字列（UUID）	はい	OAuth 2.0クライアントを所有するログインプロジェクトのID。
resources	配列	はい	OAuth 2.0クライアントが所有するリソースのリスト。可能なリソースのタイプ： publisher_id — ログインプロジェクトを所有するマーチャントのリソース publisher_project_id — アドミンページでのプロジェクトのリソース。 各グループは以下のフォーマットで書かれます： name — リソースタイプ value — リソースID
jti	文字列	はい	一意のトークンID。

認証に成功すると、すべてのユーザーに対してJWTが生成されます。生成されたJWTは秘密鍵で署名されていま す。JWTが適切であり、ログインプロジェクトのユーザーに属していることを確認するために、その値を検証する必要があります。

JWTを検証するには：

1. パブリッシャーアカウントでプロジェクトを開き、ログインセクションに移動します。
2. ログインオプションのパネルで 構成をクリックします。
3. ナビゲーションページで、セキュリティブロックに移動し、JWT 署名セクションを選択します。
4. 暗号化方式を選択し、選択した方式に応じて秘密キーまたは新しい公開 JSON ウェブキーフィールドの値をコピーします。
5. ライブラリを選択し、アプリケーションのサーバー側に接続します。
6. ステップ4でコピーした値を検証関数のエントリに渡します。

エラー応答の場合、エクソーラログインサーバーは以下のフィールドを持つJSONオブジェクトを返します：

フィールド	タイプ	説明
code	文字列	エクソーラログインサーバーのエラーコード。
説明	文字列	エラーの説明。テキストは常に英語です。値は将来変更される可能性があるため、エラーの場合はこのテキストを使用しないでください。

{
  "error": {
    "code": "000-000",
    "description": "description"
  }
}