Setting up authentication via deep link

Deep links allow the user to authenticate in the Web Shop through the game in one click, instead of going through the authentication process via user ID or Xsolla Login.

If the game is installed on the user’s mobile device, they will be redirected to the game via deep link to get an authorization token.

User flow

In the mobile app

1. An unauthorized user in the Web Shop clicks the login button or the buy button. A modal window for entering the user ID or logging in through the mobile game opens.

2. The user clicks the login button through the game.
3. The user is redirected to the game where they are automatically redirected to Web Shop as an authorized user.

In the desktop version

1. An unauthorized user in the Web Shop clicks the login button or the buy button. A modal window for entering the user ID or logging into the mobile version of the game using a QR code opens.

2. The user scans the QR code using their mobile device, after which the Web Shop opens on their mobile device.
3. The mobile version of the game opens on the user's mobile device.
4. The user is automatically redirected to Web Shop on the mobile device as an authorized user.

Services interaction flow

How to set up

On the game side

1. In your game’s mobile app settings, register a URL scheme to open the game via deep link:
   • in Android applications — in the AndroidManifest.xml file
   • in iOS applications — in the Info.plist file

• gamename — the name of your game that should open on a mobile device for user authentication.
• authorize — an example of an action name that should be performed after the gamename game opens. Use the action name that matches the actions in your application’s operating system.

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

Example of registering a URL scheme in Android applications:

<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. Implement the generation of an authorization token in JWT format using the user ID from the game.

Example of calling the user token generation API method using curl:

curl --location 'https://sb-user-id-service.xsolla.com/api/v1/user-id' \
--header 'Content-Type: application/json' \
--data '{
 "loginId": "000001aa-001a-0ab0-00001-01a01a01a01a",
 "webhookUrl": "https://nowebhook.com",
 "settings": {
   "projectId": 123456,
   "merchantId": 123456
 },
 "user": {
   "id": "123",
   "name": "a-user-name"
 }
}'

You will get a response like {token=“JWT_TOKEN”}.

3. Add a pop-up window with a notification of successful authorization (optional).
4. Implement the opening of the Web Shop in the browser using the obtained user token.

Example of creating a URL for opening the Web Shop in the browser for an authorized user:

• https:​//example.com/?token={token}, if you are using a custom domain
• https:​//example.xsollasitebuilder.com/?token={token}, if you are using an Xsolla domain

Within Site Builder

1. Open the project in the Publisher Account.
2. In the side menu, click Site Builder.
3. Click Configure on the card of your Web Shop site with authentication via User ID.
4. Go to the Login Settings and select the User ID section.
5. Set Deeplink authorization toggle to On.

6. In the Deeplink URL field enter the link for user authentication.

7. If you are using the Fast Login block on the site:
   1. Go to the Fast Login block.
   2. In the Layout section, set the QR code toggle to On.

8. To check the authentication, click on Preview.
9. To publish the website, click on Publish.