- バージョン： 1.0.0
- サーバー：
https://login.xsolla.com/api - プロトコル：https
- 承認：application / json
- 応答：application / json
- メールでお問い合わせください
- 連絡先URL： https://xsolla.com/
このセクションでは、ログイン を操作するための API 呼び出しについて説明します。リクエストを送信する前に、パブリッシャー アカウント でログイン プロジェクトを セットアップ してください。
The full list of IP addresses that login.xsolla.com may use:
- 34.94.0.85
- 34.94.14.95
- 34.94.25.33
- 34.94.115.185
- 34.94.154.26
- 34.94.173.132
- 34.102.48.30
- 35.235.99.248
- 35.236.32.131
- 35.236.35.100
- 35.236.117.164
アドミンページでは、次のログインプロジェクトタイプにアクセスできます：
- 標準ログインプロジェクト
- シャドウログインプロジェクト
詳細については、クロスプラットフォームアカウント機能を参照してください。
Are the restrictions applied by Xsolla API on the frequency of access by a user within a defined timeframe.
標準ログインプロジェクトで作成され、プラットフォームアカウントにリンクされているアカウントタイプです。メインアカウントは、異なるプラットフォームでプレーヤーを識 別するために使用されます。
シャドウログインプロジェクトで作成され、確定したパブリッシングプラットフォームに接続されるアカウントタイプです。プラットフォームアカウントは、他のプラットフォー ムアカウントとリンクすることはできません。また、メインアカウントからアカウントのリンクを解除することもできません。
Login APIは、以下のトークンタイプをサポートしています：
- ユーザートークン。これは、以下のユーザーリソースにリクエストを送信するために使用されます：
- プロフィール
- 友達
- 属性
- サーバートークン。設定やユーザーデータなど、アプリケーションリソースへのリクエストを送信するために使用されます。以下のリクエストが利用可能です：
認証スキームによって、APIコールがクライアント側かサーバー側かを判断できます：
- Client-side — are called without authentication or with the
Authorizationheader:Bearer <user_JWT>header, where<user_JWT>— is the user token. - Server-side API calls for implementing the user flow — are called with the
header:
X-SERVER-AUTHORIZATION: <server_JWT>, where<server_JWT>— is the server token.
トークンを取得するには、次のいずれかのリクエストを送信します：
- ユーザー登録（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）と交換します。
サーバートークンを取得するには：
サーバーOAuth 2.0クライアントをセットアップする
- パブリッシャーアカウントでプロジェクトを開き、ログインセクションに移動します。
- ログインプロジェクトのパネルで構成をクリックします。
- セキュリティブロックに移動し、OAuth 2.0セクションを選択します。
- Click Add OAuth 2.0 Client.
- **サーバー (server-to-server connection)**ボックスのチェックを入れます。
- トークンの有効期間を指定します。
- 接続をクリックします。
- クライアントIDと秘密キーをコピーして保存します。
サーバーJWTを生成
アプリケーションのバックエンドで、JWT APIを生成するコールを使用してサーバーJWTを取得するメソッドを実装します。リクエストには次のパラメータが含まれている必要があります。
grant_typeis the type of getting JWT, pass theclient_credentialsvalue.client_secretis the secret key that is received when you set up the server OAuth 2.0 client.client_idis the client ID received when you set up the server OAuth 2.0 client.
To prevent Xsolla system overloads and protect against sudden spikes in
incoming traffic, Xsolla limits the number of requests received by the Xsolla
API within a specified period of time. If the limit is exceeded, the Xsolla API
returns an HTTP response with the 429 status code.
Rate limits vary by method, IP-address, authentication scheme, and other factors.
Rate limits for server-side methods are applied to methods with server-side
authentication — methods that are called with the X-SERVER-AUTHORIZATION:
<server_JWT> header, where <server_JWT> is the server
token.
Rate limits for client-side methods are applied to methods without
authentication or with client-side authentication — methods that are called
with the Authorization: Bearer <user_JWT> header, where
<user_JWT> is the user token.
Example of a method with server-side authentication: 
Example of a method with client-side authentication:
Rate limits for client-side methods do not change and are necessary to prevent brute-force attacks. The maximum request rate for server-side methods is higher than for client-side methods. You can refer to the recommendations on how to manage rate limits in the documentation.
すべてのトークンには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 |
配列 | はい |
ユーザーが所属しているグループのリスト。各グループは以下のフォーマットで書かれます：
デフォルトグループは1つしか存在できません。このグループには、異なるグループに分散される前のすべてのユーザーが初期状態で含まれています。 |
xsolla_login_project_id |
文字列（UUID） | はい | ログインプロジェクトID。 |
type |
文字列 |
認証オプション：
デフォルトグループは1つしか存在できません。このグループには、異なるグループに分散される前のすべてのユーザーが初期状態で含まれています。 |
|
avatar |
文字列 | ユーザーのアバターURL。 | |
username |
文字列 | ユーザー名。 | |
publisher_id |
integer | ログインプロジェクトを所有するマーチャントのID。 | |
email |
文字列 | ユーザーのメールアドレス。 | |
payload |
文字列 | 認証時にペイロードパラメータで渡される追加情報。 | |
promo_email_agreement |
ブール型 |
次のいずれかの値になります：
trueの値になります。
ログインウィジェットの登録フォームに機能を追加するには：
|
|
connection_information |
文字列 | ユーザーが生年月日を確認したかどうかを表示します。確認はoknameサービスを通じて行われます。 |
PlayFabストレージを使用する場合、認証後にトークンに含まれる要求。
| クレーム | タイプ | 必須 | 説明 |
external_account_id |
文字列 | はい | ユーザーPlayFab ID。 |
session_ticket |
文字列 | はい |
PlayFab APIへの認証リクエストまたはリクエストの間に受け取ったSessionTicketパラメータです。 OAuth 2.0プロトコルを経由でユーザーを認証し、 |
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 |
Data of any type returned by your server in the response body during authentication. To enable the transmission of this claim, contact your Customer Success Manager or email to csm@xsolla.com | ||
social_access_token |
Access token of the social network through which the user was authenticated. To enable the transmission of this claim, contact your Customer Success Manager or email to csm@xsolla.com. |
ソーシャルネットワーク経由の認証後、トークンに含まれる要求。これらの要求の存在は、ユーザーデータベースに依存しません。
| クレーム | タイプ | 必須 | 説明 |
provider |
文字列 | はい | 認証に使用されるソーシャルネットワークの名前。 |
id |
文字列 | はい | ソーシャルネットワークにおけるユーザーID。 |
is_cross_auth |
ブール型 | サイレント認証のリクエストが進行中であることを示します。 | |
social_access_token |
文字列 | 認証に使用するソーシャルネットワークアカウントのaccess_tokenパラメータ。この機能をセットアップするには、アカウントマネージャーにお問い合わせください。 |
|
picture |
文字列（URL） | ソーシャルネットワークにおけるユーザープロフィール画像へのリンク。 | |
birthday |
日付（RFC3339） | ソーシャルネットワークにおけるユーザーの誕生日。 | |
gender |
文字列 | ソーシャルネットワークにおけるユーザー性別。 | |
name |
文字列 | ソーシャルネットワークにおけるユーザーニックネーム。 |
電話番号経由の認証後、トークンに含まれる要求。
| クレーム | タイプ | 必須 | 説明 |
phone_number |
文字列 | はい | 認証に使用されるユーザーの電話番号。電話番号は、国番号、市外局番、回線番号からなる区切りのない形式です。 |
サーバートークンは、X-SERVER-AUTHORIZATIONヘッダーで渡されます。
トークンのペイロードには、OAuth 2.0クライアントが所有するリソースに関する情報が含まれています。トークンは、これらのリソースに対するサーバーベースの認証によるコールにアクセスできます。
| クレーム | タイプ | 必須 | 説明 |
xsolla_login_project_id |
文字列（UUID） | はい | OAuth 2.0クライアントを所有するログインプロジェクトのID。 |
resources |
配列 | はい |
OAuth 2.0クライアントが所有するリソースのリスト。可能なリソースのタイプ：
各グループは以下のフォーマットで書かれます：
|
jti |
文字列 | はい | 一意のトークンID。 |
To validate the JWT, use the following Login API calls:
- User JWT validate — for a user token.
- Server JWT validate — for a server token.
通知
秘密鍵は他人に教えないでください。漏洩した場合は、更新してください。
エラー
エラー応答の場合、エクソーラログインサーバーは以下のフィールドを持つJSONオブジェクトを返します：
| フィールド | タイプ | 説明 |
| code | 文字列 | エクソーラログインサーバーのエラーコード。 |
| 説明 | 文字列 | エラーの説明。テキストは常に英語です。値は将来変更される可能性があるため、エラーの場合はこのテキストを使用しないでください。 |
{
"error": {
"code": "000-000",
"description": "description"
}
}
| Error Code | Description | Recommendation | |---------------------------|---------------------------------------------------
---------------------------------------------------------------------------|:---
---------------------------------------------------------------------------:| |
002-016 | accountID
parameter in the response body. | | 008-009 |
Policies and Agreements). | | 008-014 |
Okta integration not completed. | Contact the integration team through any messenger. | | 008-015 |SAML integration not completed. | Contact the integration team through any messenger. | | 008-016 |Firebase API key not set. | Add the API key to the settings in your Publisher Account (section Legal Terms > Policies and Agreements). | | 010-004 |Service temporarily unavailable. Try again later. | The user should try again later. | | 010-005 |Allowable number of requests exceeded. Try again later. | The user should try again later. | | 010-006 |If this social profile is unlinked, no authentication methods will be available. | The user should add another authentication method before unlinking the social network. | | 010-007 |Incorrect CAPTCHA input. Try again. | The user should complete the CAPTCHA again. | | 010-010 |Invalid confirmation code. | The user should verify the code and try again. | | 010-014 |Your code is expired. Return to the login page and log in again. | The user should log in again from the login page. | | 010-015 |Something went wrong during authentication with this social network. Try again later. | The user should try again later. | | 010-016 |This social account is already linked to another user. | The user should use a different social account. If they believe this is an error, they should contact the integration team through any messenger. | | 010-017 |Client authentication failed. Some request parameters are missing in request or have invalid values. | Verify the correctness of the request parameters being sent. | | 010-019 |Client authentication failed. Client with this client_id value does not exist. | Ensure that a client with the providedclient_idexists. | | 010-020 |Client authentication failed. Parameter scope is invalid or malformed. | Ensure that the providedscopeparameter is correct. Refer to the instructions for detailed setup information. | | 010-021 |Client authentication failed. Parameter response_type is invalid or malformed. You should pass value of code parameter to response_type. | Ensure that the value of theresponse_typeparameter is set to"code". | | 010-022 |Client authentication failed. Parameter state is missing or its value has less than 8 characters. | Ensure that the state parameter is present and consists of at least 8 characters. | | 010-023 |Client authentication failed. Authorization code, authorization grant types, or refresh token are invalid or expired. Also this error is returned when the redirect_uri given in authorization grant type does not match the URI provided in access token request. | Ensure that the authorization code is valid and not expired, and that theredirect_uriparameter contains an authorized URL. Refer to the instructions for detailed setup information. | | 010-026 |The resource owner or authorization server denied the request. | Ensure that you have sufficient permissions to access the resource. | | 010-030 |Cross social network is not enabled for this Login. | Ensure that cross-authentication is enabled for the authorization option. Refer to the instructions for detailed setup information. | | 010-031 |Social provider already exists. | The error occurs when attempting to connect a social network that is already enabled. | | 010-032 |Social network is not enabled for this Login. You can enable it in your Xsolla Publisher Account > Login Project > Social connections. | Ensure that the social network is enabled and configured in the authorization option settings in your Publisher Account (section Authorization via Social Networks). | | 010-033 |This call is temporary unavailable. | The user should try again later. | | 010-035 |Dependency service is unavailable | The user should try again later. | | 010-045 |Account with this social provider email address already exists. | The user should use a different social account for registration. | | 030-024 |Password recovery is not allowed. | The user should contact the game support team. | | 040-001 |Email address must be 254 characters or shorter. | The user should enter an email address containing no more than 254 characters. | | 040-002 |Username of the email address is invalid. Try another email address. | The user should enter a valid email address. | | 040-003 |Local part of the email address is too long. | The user should enter a different email address. | | 040-004 |Email address domain is invalid. Try another email address. | The user should contact Xsolla support. | | 040-005 |Email address should contain one @ character only. (E.g., username@example.com) | The user should enter an email with only one@character. | | 040-006, 040-007, 040-008 |Email address domain is invalid. Try another email address. | The user should contact Xsolla support. | | 040-009 |Email address domain doesn’t exist. Try another email address. | The user should enter an email with an existing domain. | | 040-010 |Email address domain is not allowed. Try another email address. | The user should contact Xsolla support. | | 010-018 |Email address is invalid. Try another email address. | The user should enter a different email address. | | 300-003 |Allowable number of requests exceeded. Try again later. | The user should try again later. | | 300-005 |Failed to resend code. Try again later. | The user should try again later. | | 300-006 |Incorrect confirmation code. Check the code that you received and try again. | The user should verify and re- enter the confirmation code. | | 300-008 |You've exceeded the maximum number of attempts. Use the new code sent to your email or phone. | The user should use the new code sent to their email or phone. | | 003-007 |User account not confirmed. | The user should confirm their email address to activate the account. If they haven't received a confirmation email, they should check the spam folder. | | 003-025 |Error occurred while getting OAuth 2.0 access token. | The user should try a different authentication method. | | 003-040 |Unauthorized user. | The user should log in again. | | 003-033 |Mismatch project type. | Ensure that shadow authentication is used for the authorization option. | | 2002-0001 |Duplicated attributes. | Make sure that the attribute being created has not been previously added to the user. |