カスタムストレージ

カスタムストレージを使用する場合、次にアクセスできます：

• ユーザー登録
• ユーザー名とパスワード経由の認証
• 電話番号経由のパスワードレス認証
• ソーシャルネットワーク経由の認証
• ユーザーパスワード再設定

統合フロー

ログインウィジェットまたはログインAPIコールを使用するアプリケーションをクライアントとして使用できます。クライアントとエクソーラログインサーバー間の対話フローは次のとおり：

1. クライアントはエクソーラログインサーバーにリクエストを送信します。リクエストの形式は、JWTおよびPasswordエンドポイントで説明されています。
2. エクソーラログインサーバーがサーバーにリクエストを送信します。指示に従ってリクエストを検証します。
3. エクソーラログインサーバーはサーバーからの応答を処理し、結果をクライアントに返します。
4. クライアントは応答を処理します。

• 任意のJSONオブジェクトとして。

• ユーザー属性を持つオブジェクトの配列として。オブジェクトの構造は、次のとおりにする必要があります。

ユーザー登録

1. クライアントは、エクソーラログインサーバーにRegister new userリクエストを送信します。
2. エクソーラログインサーバーは、「新規ユーザーURL」にリクエストを送信します。応答は、この統合フローで説明されている形式である必要があります。応答では、ユーザー属性のリストまたは必要なJSONオブジェクトを指定できます。応答で提供されたJSONオブジェクトは、ユーザーのJWTのpartner_dataフィールドに記録されます。

POST https://your.hostname/your_registration_uri HTTP/1.1
Authorization: Bearer {JWT}
Content-Type: application/json

{
  "email":"j.smith@email.com",
  "password":"123456",
  "username":"j.smith@email.com"
}

curl --request POST \
  --url 'https://your.hostname/your_registration_uri' \
  --header 'authorization: bearer_JWT' \
  --header 'content-type: application/json' \
  --data '{"email":"j.smith@email.com","password":"123456","username":"j.smith@email.com"}'

ユーザー属性を持つ応答の例：

{
    "attributes": [
      {
        "attr_type": "server",
        "key": "company",
        "permission": "private",
        "value": "facebook-promo"
      },
      {
        "attr_type": "server",
        "key": "custom-id",
        "permission": "private",
        "value": 48582
      }
    ]
}

JSONオブジェクトを使用したレスポンスの例：

{ "region": "Asia",
  "type": "new"
}

3. emailにフラグが付けられ、未確認の時、ユーザーデータはエクソーラデータベースに書き込まれます。ユーザーはアカウント確認メールを受け取ります。
4. ログインウィジェットを統合している場合、ユーザーは次のメッセージとともにページにリダイレクトされます：{email}に送信した指示に従って、アカウントを確認してください。
5. ユーザー登録に失敗した場合、認証ウィジェットに表示されるエラーメッセージを提供することができます。これを行うには、ユーザ作成リクエストの応答で、以下の詳細を持つerrorオブジェクトを渡します：
   • codeパラメータで、011-002を指定します。
   • descriptionパラメータには、エラーメッセージのテキストを提供します。

{
  "error": {
    "code": "011-002",
    "description": "<string>"
  }
}

ユーザー名とパスワードによる認証

1. クライアントは、エクソーラログインサーバーにAuth by username and passwordリクエストを送信します。
2. エクソーラログインサーバーは、「ユーザー検証URL」にリクエストを送信します。応答は、この統合フローで説明されている形式である必要があります。応答では、ユーザー属性のリストまたは必要なJSONオブジェクトを指定できます。応答で提供されたJSONオブジェクトは、ユーザーのJWTのpartner_dataフィールドに記録されます。

POST https://your.hostname/your_authentication_uri HTTP/1.1
Authorization: Bearer {JWT}
Content-Type: application/json

{
  "email":"j.smith@email.com",
  "password":"123456",
  "username":"j.smith@email.com"
}

curl --request POST \
  --url 'https://your.hostname/your_authentication_uri' \
  --header 'authorization: bearer_JWT' \
  --header 'content-type: application/json' \
  --data '{"email":"j.smith@email.com","password":"123456","username":"j.smith@email.com"}'

ユーザー属性を持つ応答の例：

{
    "attributes": [
      {
        "attr_type": "server",
        "key": "company",
        "permission": "private",
        "value": "facebook-promo"
      },
      {
        "attr_type": "server",
        "key": "custom-id",
        "permission": "private",
        "value": 48582
      }
    ]
}

JSONオブジェクトを使用したレスポンスの例：

{ "region": "Asia",
  "type": "new"
}

3. エクソーラログインサーバーはユーザーJWTを生成します。
4. ユーザーはtokenクエリパラメータのあるlogin_urlにリダイレクトされます。tokenパラメータにはユーザーJWTが含まれます。

電話番号経由のパスワードレス認証

1. クライアントは認証フォームを開き、ユーザーが電話番号を入力できるようにします。
2. ユーザーは電話番号を入力します。
3. クライアントはエクソーラログインサーバーにStart auth by phone numberリクエストを送信します。
4. クライアントは、ユーザーが検証コードを入力できるようにフィールドを表示します。
5. ユーザーは受信した検証コードを入力します。
6. クライアントはエクソーラログインにComplete auth by phone numberリクエストを送信します。
7. それが最初のユーザ認証である場合、エクソーラログインサーバは、電話URL付きのパスワードレスログインにリクエストを送信します。応答は、この統合フローに記載されている形式でなければなりません。応答では、ユーザー属性のリストまたは必要なJSONオブジェクトを指定できます。応答で指定したJSONオブジェクトは、ユーザーのJWTのpartner_dataフィールドに記録されます。

POST https://your.hostname/your_phone_authentication_uri HTTP/1.1
Authorization: Bearer {JWT}
Content-Type: application/json

{
  "login": "+12025550140",
  "type": "phone"
}

curl --request POST \
  --url 'https://your.hostname/your_phone_authentication_uri' \
  --header 'authorization: bearer_JWT' \
  --header 'content-type: application/json' \
  --data '{"login":"+12025550140","type":"phone"}'

ユーザー属性を持つ応答の例：

{
    "attributes": [
      {
        "attr_type": "server",
        "key": "company",
        "permission": "private",
        "value": "facebook-promo"
      },
      {
        "attr_type": "server",
        "key": "custom-id",
        "permission": "private",
        "value": 48582
      }
    ]
}

JSONオブジェクトを使用したレスポンスの例：

{ "region": "Asia",
  "type": "new"
}

メール経由でパスワードレス認証

1. クライアントは認証フォームを開き、ユーザーがメールアドレスを入力できるようにします。
2. ユーザーはメールアドレスを入力します。
3. クライアントはエクソーラログインサーバーにStart auth by emailリクエストを送信します。
4. クライアントは、ユーザーが検証コードを入力できるようにフィールドを表示します。
5. ユーザーは受信した検証コードを入力します。
6. クライアントはエクソーラログインにComplete auth by emailリクエストを送信します。
7. それが最初のユーザ認証である場合、エクソーラログインサーバは、電話URL付きのパスワードレスログインにリクエストを送信します。応答は、この統合フローに記載されている形式でなければなりません。応答では、ユーザー属性のリストまたは必要なJSONオブジェクトを指定できます。応答で指定したJSONオブジェクトは、ユーザーのJWTのpartner_dataフィールドに記録されます。

POST https://your.hostname/your_email_authentication_uri HTTP/1.1
Authorization: Bearer {JWT}
Content-Type: application/json

{
  "email": "user@mail.com",
  "type": "email"
}

curl --request POST \
  --url 'https://your.hostname/your_email_authentication_uri' \
  --header 'authorization: bearer_JWT' \
  --header 'content-type: application/json' \
  --data '{"email": "user@mail.com","type": "email"}'

ユーザー属性を持つ応答の例：

{
    "attributes": [
      {
        "attr_type": "server",
        "key": "company",
        "permission": "private",
        "value": "facebook-promo"
      },
      {
        "attr_type": "server",
        "key": "custom-id",
        "permission": "private",
        "value": 48582
      }
    ]
}

JSONオブジェクトを使用したレスポンスの例：

{ "region": "Asia",
  "type": "new"
}

ソーシャルネットワーク経由の認証

ソーシャルネットワーク経由の認証時にユーザーデータを取得するには、アドミンページのログインプロジェクトの設定（セクションユーザーデータベース > ストレージ > カスタムストレージ）で、ソーシャルログインURLを指定します。ソーシャルネットワークから受信したデータを含むリクエストがこのURLに送信されます。

認証フロー：

1. クライアントはAuth via social networkリクエストをエクソーラログインサーバーに送信します。
2. ユーザーがソーシャルネットワークにログインします。
3. エクソーラログインサーバーは、ソーシャルネットワークから受信したユーザーデータを処理し、「ソーシャルログインURL」にリクエストを送信します。応答は、シナリオで説明されている形式である必要があります。応答では、ユーザー属性のリストまたは必要なJSONオブジェクトを指定できます。応答で指定したJSONオブジェクトは、ユーザーのJWTのpartner_dataフィールドに記録されます。

{
  "exp": 1573635020,
  "iat": 1573634600,
  "iss": "https://login.xsolla.com",
  "request_type": "gateway_request",
  "xsolla_login_project_id": "00000000-0000-0000-0000-000000000000",
  "sub": "00000000-0000-0000-0000-000000000000",
  "email": "example@test.com",
  "username": "Smith707",
  "provider": "google",
  "id": "123",
}

新しいユーザーURLの応答例：

POST https://your.hostname/your_social_authentication_uri HTTP/1.1
Authorization: Bearer {JWT}
Content-Type: application/json

{}

curl --request POST \
  --url 'https://your.hostname/your_social_authentication_uri' \
  --header 'authorization: bearer_JWT' \
  --header 'content-type: application/json'

ユーザー属性を持つ応答の例：

{
    "attributes": [
      {
        "attr_type": "server",
        "key": "company",
        "permission": "private",
        "value": "facebook-promo"
      },
      {
        "attr_type": "server",
        "key": "custom-id",
        "permission": "private",
        "value": 48582
      }
    ]
}

JSONオブジェクトを使用したレスポンスの例：

{ "region": "Asia",
  "type": "new"
}

ユーザーパスワードのリセット

1. クライアントは、Reset passwordリクエストをエクソーラログインサーバーに送信します。
2. エクソーラログインサーバーは、ユーザーにパスワードリセットの確認メールを送信します。
3. 電子メールでパスワードのリセットを確認した後、ユーザーは新しいパスワードを入力できるページにリダイレクトされます。
4. ユーザーは新しいパスワードを入力します。
5. エクソーラログインサーバーは、パスワードリセットURLにリクエストを送信します。

新しいユーザーURLの応答例：

POST https://your.hostname/your_reset_uri HTTP/1.1
Authorization: Bearer {JWT}
Content-Type: application/json

{
  "username": "john@gmail.com",
  "fields": {
    "password": "NewPa$$word1"
  }
}

curl --request POST \
  --url 'https://your.hostname/your_reset_uri' \
  --header 'authorization: bearer_JWT' \
  --header 'content-type: application/json' \
  --data '{"email":"john@gmail.com","fields":{"password":"NewPa$$word1"}}'

続きを読む