用户流程

1. 用户使用配置的用户ID认证前往网页商城。
2. 用户通过以下方式之一授权进入网页商城：
   • 用户在快速登录区块输入其ID并点击登录按钮。
   • 用户点击所选商品的购买按钮或页首栏中的登录按钮：
     1. 一个用于输入用户ID或使用社交网络登录的模态窗口将打开。
     2. 用户输入其ID并点击继续，或点击社交网络图标选择一个社交网络并在社交网络页面上完成身份认证。

3. 系统检查用户在游戏中是否存在。如游戏中存在该ID或该社交帐户的用户，用户即在网页商城中完成授权，否则将显示错误消息。

如何获取

1. 在您的应用程序侧，实现对用户验证Webhook的处理。

收到Webhook后，应用程序应执行以下操作：

• 根据Webhook中传入的ID搜索用户。
• 根据结果发送以下状态代码之一：
  • 如找到了该用户，发送200 HTTP代码和Webhook回应
  • 如未找到该用户，发送404 HTTP代码
  如要进行个性化，
• 发送用户属性。

2. 在发布商帐户中打开您的项目。
3. 在侧边栏中单击建站器。
4. 单击打开建站器。
5. 前往登录设置区块。

6. 选择用户ID选项。

7. 在下拉列表中，选择新建登录管理器。

8. 输入接收Webhook的URL。

9. 设置通过应用程序连接的社交网络进行认证（可选）：
   1. 在发布商帐户中打开您的项目，然后前往登录管理器部分。
   2. 在网站栏中单击配置。
   3. 前往身份认证区块，然后选择社交网络登录。

1. 4. 要设置社交网络，请前往社交网络版块，单击标题右侧的⚙图标，然后选择连接。

深度链接是一种特殊的URL，不仅可以将用户跳转至应用程序或网站的主页面，还可以直接将其跳转至特定的区段、页面或操作。

深度链接可用作用户ID登录时的额外身份认证方式。如果游戏安装在用户移动设备上，将通过深度链接跳转到游戏获取一个授权令牌。

用户流程

在移动应用中

1. 网页商城中的未授权用户点击登录按钮或购买按钮。随后将打开一个用于输入用户ID或通过移动游戏登录的模态窗口。

2. 用户点击通过手机游戏登录按钮。
3. 用户将被跳转至游戏，然后自动以授权用户身份返回网页商城。

在桌面版本中

1. 网页商城中的未授权用户点击登录按钮或购买按钮。随后将打开一个用于输入用户ID或使用二维码登录游戏移动版本的模态窗口。

2. 用户使用移动设备扫描二维码。
3. 网页商城在用户的移动设备上打开。
4. 用户自动跳转至游戏，然后以已认证用户身份返回网页商城。

服务交互过程

如何设置

游戏侧

1. 在游戏的移动应用设置中，注册一个URL机制来通过深度链接打开游戏：
   • Android应用 — AndroidManifest.xml文件中
   • iOS应用 — Info.plist文件中

注册机制后，用户通过游戏认证进入网页商城时，游戏应在指定地址打开。

游戏注册URL机制示例：
gamename://authorize?operationPayload=<VALUE>，其中：
• gamename — 将在移动设备上打开用于用户身份认证的游戏名称。
• authorize — 游戏打开后要执行的操作名称示例。请使用与应用程序操作系统中的操作相匹配的操作名称。
• operationPayload=<VALUE> — 包含身份认证过程中用于生成令牌的信息的附加参数。

示例：

• 在iOS应用程序中注册URL机制
• 在Android应用程序中注册URL机制

Copy

Full screen

Small screen

• xml

<key>CFBundleURLTypes</key>
  <array>
    <dict>
      <key>CFBundleTypeRole</key>
      <string>Editor</string>
      <key>CFBundleURLSchemes</key>
      <array>
        <string>gamename</string>
      </array>
    </dict>
  </array>

Copy

Full screen

Small screen

• xml

<intent-filter>
    <action android:name="android.intent.action.VIEW" />
    <category android:name="android.intent.category.DEFAULT" />
    <category android:name="android.intent.category.BROWSABLE" />
    <data android:scheme="gamename" android:host="authorize" />
</intent-filter>

2. 实现使用游戏中的用户ID生成JWT格式的授权令牌。

使用curl调用用户令牌生成API方法的示例：

curl -X 'POST' \
'https://sb-user-id-service.xsolla.com/api/v1/user-id/token' \
-H 'accept: /' \
-H 'Content-Type: application/json' \
-d '{
 "loginId": "000001aa-001a-0ab0-00001-01a01a01a01a",
 "settings": {
   "projectId": 123456,
   "merchantId": 123456
 },
 "user": {
   "id": "123",
   "country": "US"
 }
 "operationPayload": "kosarb2NyrtIWaegJAH1f6P7XrBYPXYDya5coc_ZzcfiS_5o4QTUAL-CcGRC_Kv4CAtg"
}'

您将获得类似于{token="JWT_TOKEN"}的响应。

3. 添加一个包含授权成功通知（可选）。
4. 实现使用获得的用户令牌在浏览器中打开网页商城。

在浏览器中为已授权用户打开网页商城的URL示例：
• https:​//example.com/?token={token}（使用自定义域名时）
• https:​//example.xsolla.site/?token={token}（使用艾克索拉域名时）

其中{token}为用户的授权令牌。

在建站器中

1. 在发布商帐户中打开您的项目，前往建站器。
2. 在包含通过用户ID进行认证的网页商城网站所在卡片上单击配置。
3. 前往登录设置，然后选择用户ID部分。
4. 启用深度链接授权开关。

5. 在深度链接URL字段，输入用于用户身份认证的链接。

6. 如在网站上使用快速登录区块：
   1. 前往快速登录区块。
   2. 在布局部分，启用二维码开关。

7. 要检查身份认证，请单击预览。
8. 要发布网站，请单击发布。

深度链接是一种特殊的URL，不仅可以将用户跳转至应用程序或网站的主页面，还可以直接将其跳转至特定的区段、页面或操作。

深度链接允许用户一键通过游戏认证进入网页商城，而无需使用用户ID或艾克索拉登录管理器经历身份认证过程。

如果游戏安装在用户移动设备上，将通过深度链接跳转到游戏获取一个授权令牌。

当深度链接作为主要身份认证方式时，用户可以保存支付详情。这是通过用户ID加深度链接进行身份认证所无法实现的功能。该情况中，深度链接仅加快身份认证速度，不提供额外功能。

用户流程

在移动应用中

1. 网页商城中的未授权用户点击登录按钮或购买按钮。随后将打开一个用于通过移动游戏登录的模态窗口。

2. 用户点击通过手机游戏登录按钮。
3. 用户将被跳转至游戏，然后自动以授权用户身份返回网页商城。

在桌面版本中

1. 网页商城中的未授权用户点击登录按钮或购买按钮。随后将打开一个使用二维码登录游戏移动版本的模态窗口。

2. 用户使用移动设备扫描二维码。
3. 网页商城在用户的移动设备上打开。
4. 用户自动跳转至游戏，然后以已认证用户身份返回网页商城。

服务交互过程

如何设置

游戏侧

1. 在游戏的移动应用设置中，注册一个URL机制来通过深度链接打开游戏：
   • Android应用 — AndroidManifest.xml文件中
   • iOS应用 — Info.plist文件中

注册机制后，用户通过游戏认证进入网页商城时，游戏应在指定地址打开。

游戏注册URL机制示例：
gamename://authorize?operationPayload=<VALUE>，其中：
• gamename — 将在移动设备上打开用于用户身份认证的游戏名称。
• authorize — 游戏打开后要执行的操作名称示例。请使用与应用程序操作系统中的操作相匹配的操作名称。
• operationPayload=<VALUE> — 包含身份认证过程中用于生成令牌的信息的附加参数。

示例：

• 在iOS应用程序中注册URL机制
• 在Android应用程序中注册URL机制

Copy

Full screen

Small screen

• xml

<key>CFBundleURLTypes</key>
  <array>
    <dict>
      <key>CFBundleTypeRole</key>
      <string>Editor</string>
      <key>CFBundleURLSchemes</key>
      <array>
        <string>gamename</string>
      </array>
    </dict>
  </array>

Copy

Full screen

Small screen

• xml

<intent-filter>
    <action android:name="android.intent.action.VIEW" />
    <category android:name="android.intent.category.DEFAULT" />
    <category android:name="android.intent.category.BROWSABLE" />
    <data android:scheme="gamename" android:host="authorize" />
</intent-filter>

2. 实现使用游戏中的用户ID生成JWT格式的授权令牌。

艾克索拉API使用基本身份认证。所有API请求都必须包含Authorization: Basic 头，其中your_authorization_basic_key是以Base64标准编码的client_id:client_secret对。

服务器身份认证的OAuth 2.0客户端设置通过发布商帐户完成。详细步骤请参阅文档。

使用curl调用用户令牌生成API方法的示例：

curl -X 'POST' \
'https://sb-user-id-service.xsolla.com/api/v1/user-id/token' \
-H 'Accept: /' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic <Base64Encoded(client_id:client_secret)>' \
-d '{
 "loginId": "000001aa-001a-0ab0-00001-01a01a01a01a",
 "settings": {
   "projectId": 123456,
   "merchantId": 123456
 },
 "user": {
   "id": "123",
   "country": "US"
 }
 "operationPayload": "kosarb2NyrtIWaegJAH1f6P7XrBYPXYDya5coc_ZzcfiS_5o4QTUAL-CcGRC_Kv4CAtg"
}'

您将获得类似于{token="JWT_TOKEN"}的响应。

3. 添加一个包含授权成功通知（可选）。
4. 实现使用获得的用户令牌在浏览器中打开网页商城。

在浏览器中为已授权用户打开网页商城的URL示例：
• https:​//example.com/?token={token}（使用自定义域名时）
• https:​//example.xsolla.site/?token={token}（使用艾克索拉域名时）

其中{token}为用户的授权令牌。

在建站器中

1. 在发布商帐户中打开您的项目，前往建站器。
2. 在您的网页商城网站卡片中，单击配置。
3. 前往登录设置，然后选择深度链接部分。

4. 在深度链接URL字段，输入用于用户身份认证的链接。

5. 如在网站上使用快速登录区块：
   1. 前往快速登录区块。
   2. 在区块设置中，调整二维码登录按钮的显示样式。

6. 要检查身份认证，请单击预览。
7. 要发布网站，请单击发布。

用户流程

1. 在配置了艾克索拉登录管理器认证的情况下，用户前往网页商城。
2. 用户点击所选商品的购买按钮、页首栏中的登录按钮或快速登录区块中的登录按钮。
3. 随后将打开一个模态窗口，其中包含在艾克索拉登录管理器中设置的身份认证方式。

4. 用户前往授权并在需要时输入补充数据。
5. 系统检查用户在游戏中是否存在。如用户在游戏中存在，用户即在网页商城中完成授权，否则将显示错误消息。

如何获取

1. 在网站的建站器中，前往登录管理器设置区块。

2. 选择艾克索拉登录管理器授权方式。
3. 在下拉菜单列表中，选择新建登录管理器。

4. 从模态窗口中前往登录管理器项目设置，或在艾克索拉登录管理器区块中单击设置认证方法。

5. 连接用户数据存储。

根据用户数据的存储方式不同，可用的产品功能也不同（请参阅用户数据存储方式比较）。

艾克索拉存储

如希望登录管理器产品处理所有认证逻辑，请连接艾克索拉存储。您将可以使用更多灵活的设置。

创建登录管理器项目时，默认会连接艾克索拉存储，无需额外配置步骤。如更改了默认存储类型后需要重新连接艾克索拉存储，请执行以下步骤：

1. 前往用户数据库区块，然后选择存储部分。
2. 选择艾克索拉存储，然后单击保存更改。

PlayFab存储

如果要使用PlayFab功能与用户交互，请连接PlayFab存储。它存储以下用户数据：

• 用户名
• 用户邮箱地址
• 用户密码
• 更详细注册表单的字段（如事先进行了设置）

使用PlayFab可实现以下功能：

• 用户注册
• 通过邮箱地址或用户名和密码进行认证
• 通过Twitch进行认证
• 用户密码重置
• 用户拦截

要连接该存储：

1. 前往用户数据库区块，然后选择存储部分。
2. 选择PlayFab。
3. 在游戏ID字段，输入PlayFab帐户中同一字段的值。
4. 单击保存更改。

Firebase存储

如果要使用Firebase功能与用户交互，请连接Firebase存储。它存储以下用户数据：

• 用户名
• 用户邮箱地址
• 用户密码
• 更详细注册表单的字段（如事先进行了设置）

1. 前往用户数据库区块，然后选择存储部分。
2. 选择Firebase。
3. 在API密钥字段，输入Firebase帐户中同一字段的值。
4. 单击保存更改。

自定义存储

如果使用自有认证系统并在自己的应用程序侧存储用户数据，请连接自定义存储。

使用自定义存储可实现以下功能：

• 用户注册
• 通过邮箱地址或用户名和密码进行认证
• 通过手机号进行免密认证
• 通过社交网络进行认证
• 用户密码重置

1. 连接自定义存储。
2. 设置对来自艾克索拉登录管理器服务器请求的处理。

连接自定义存储

1. 前往用户数据库区块，然后选择存储部分。
2. 选择自定义存储。
3. 输入API请求要发送到的URL：
   • 用户验证URL
   • 新用户URL
   • 密码重置URL
   • 通过手机进行无密码登录URL
   • 社交帐户登录URL
4. 单击保存更改。
5. 对所设置的URL实现以如下形式响应的API：
   • 使用HTTP 200/HTTP 204指示请求成功。如果需要，可以将包含其他用户数据的JSON置于响应正文中。传输的数据将写入JWT（partner_data参数）。
   • 使用其他HTTP状态代码指示失败的请求。

设置对来自艾克索拉登录管理器服务器的请求进行处理

艾克索拉登录管理器服务器请求发送至在发布商帐户中指定的URL，且包含Authorization: Bearer <JWT>头。JWT使用您的项目密钥签名。

要处理请求：

1. 验证收到的JWT。
2. 如果验证成功，解码JWT并确保其包含下表中的声明。查找并使用库进行解码。

{
  "exp": 1573635020,
  "iat": 1573634600,
  "iss": "https://login.xsolla.com",
  "request_type": "gateway_request",
  "xsolla_login_project_id": "00000000-0000-0000-0000-000000000000"
}