Authenticate users in your application

To ensure security and correct operation of payment transactions, the Xsolla API uses the user JSON Web Token (JWT), obtained during authorization using Xsolla Login.

Below, you can find instructions for the fastest way to integrate Xsolla Login — integrating a ready-made web widget into the application.

If you want to use your own UI to log users into your application, you should implement user authentication logic using the Login API or SDK methods.

Choose the most suitable SDK for your project:

General instructions for importing the widget and working with it are given in the README file.

Use test web applications as an implementation example:

Connect Xsolla Login widget SDK

The Xsolla Login widget is available for installation using the NPM package manager or the <script> tag on an HTML page.

Connect the Xsolla Login widget SDK in one of the following ways:

Launch the console and run the command:

Copy

Full screen

Small screen

npm i @xsolla/login-sdk

Initialize Xsolla Login widget SDK

Initialize the widget using one of the methods below. Specify the following parameters:

projectId — Login project ID. You can find it in your project in Publisher Account, in the Login > Dashboard section.
preferredLocale — the interface language. The following languages are supported: Arabic (ar_AE), Bulgarian (bg_BG), Czech (cz_CZ), English (en_US), German (de_DE), Spanish (es_ES), French (fr_FR), Hebrew (he_IL), Italian (it_IT), Japanese (ja_JP), Korean (ko_KR), Polish (pl_PL), Portuguese (pt_BR), Romanian (ro_RO), Russian (ru_RU), Thai (th_TH), Turkish (tr_TR), Vietnamese (vi_VN), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW).
clientId — OAuth 2.0 client ID. You can find it in your project in Publisher Account, in the Login > your Login project > Security > OAuth 2.0 section.
redirectUri — The URL the user is redirected to after they confirm their account, log in, or confirm password reset. Must be specified in the Publisher Account in the OAuth 2.0 client settings.

Leave the rest of the parameters unchanged.

Add the initialization code to the JS file:

Copy

Full screen

Small screen

import { Widget } from '@xsolla/login-sdk';
const xl = new Widget({
  projectId: 'LOGIN_PROJECT_ID',
  preferredLocale: 'en_US'
  clientId: 'CLIENT_ID',
  responseType: 'code',
  state: 'CUSTOM_STATE',
  redirectUri: 'REDIRECT_URI',
  scope: 'SCOPE'
});

Add the widget initialization code to the <body> tag:

Copy

Full screen

Small screen

<script>
const xl = new XsollaLogin.Widget({
  projectId: 'LOGIN_PROJECT_ID',
  preferredLocale: 'en_US',
  clientId: 'CLIENT_ID',
  responseType: 'code',
  state: 'CUSTOM_STATE',
  redirectUri: 'REDIRECT_URI',
  scope: 'SCOPE'
});
</script>

Add Xsolla Login widget opening

Add a button with the on-click event and the xl.open() function to your HTML page:

Copy

Full screen

Small screen

<div id="xl_auth" style="display: none"></div>
<button onclick="showFullscreen()">Fullscreen widget</button>

Add the code to open the widget in the <div> block of your HTML page.

Add the following code to the JS file:

Copy

Full screen

Small screen

xl.mount('xl_auth');
const showFullscreen = () => {
  const myDiv = document.querySelector('#xl_auth');
  myDiv.style.display = 'block';
  xl.open();
}

Add the code for opening the widget to the <body> tag:

Copy

Full screen

Small screen

<script type="text/javascript">
  xl.mount('xl_auth');

  function showFullscreen() {
    const myDiv = document.querySelector('#xl_auth');
    myDiv.style.display = 'block';

    xl.open();
  }
</script>

For general instructions on installing and using the SDK, see documentation of SDK for Unity (PC, web).

Import package from an archive

Download the latest SDK version (recommended) or choose the required SDK version on GitHub and download it.
Unzip the package.
Open your Unity project or create a new one.
In the Unity editor, go to Assets > Import Package > Custom Package in the main menu and select the SDK.

Set up compiler

We recommend you use the Mono compiler for desktop platforms as it’s compatible with the provided in-game browser. If you use other browser solutions, you can use the IL2CPP compiler instead.

Make sure that the Mono compiler is used to create a game build (for standalone builds only). To do this:

Click Edit > Project Settings in the main menu.
Go to the Player > Other Settings > Configuration section.
Make sure that Mono is selected in the Scripting Backend field.

Set up SDK

Open your Unity project.
Click Window > Xsolla > Edit Settings in the main menu.
Specify the main project parameters in the Inspector panel in one of the following ways:

1. Import settings from Publisher Account:
  1. Click Fill settings by PA.
  2. Specify Publisher Account authorization data in the Login and Password fields.
  3. Click Log In.
  4. Fill in the fields in the Publisher Account section.

1. 1. Click Apply Settings.

If you use a social network to register in Publisher Account, you need to add a password in one of the following ways to be able to import settings from your Publisher Account:

On the sign-up/login page of Publisher Account, click Forgot your password? and follow the instructions.
Specify a new password in Publisher Account in the Profile settings > Change password section (in the Current password field, enter an arbitrary value).

1. Specify the parameters manually:
  1. In the Project ID field, specify the project ID that can be found in Publisher Account next to the name of your project.
  2. In the Login ID field, specify the ID of the Login project. To get it, open Publisher Account, go to the Login > Dashboard > your Login project section, and click Copy ID next to the name of the Login project.
  3. In the Callback URL field, specify the URL or path where users are redirected after they have been successfully authenticated, confirmed their email, or reset their password. The value must match the one specified in Publisher Account in the Login > your Login project > Security > OAuth 2.0 section.

1. 1. In the OAuth Client ID field, specify client ID for OAuth 2.0 that can be found in Publisher Account in the Login > your Login project > Security > OAuth 2.0 section.

Set other settings if necessary (e.g., display options for the payment UI in the Pay Station UI section).

Add Xsolla Login widget opening

To open the widget, call the XsollaAuth.AuthWithXsollaWidget SDK method, passing the following parameters:

onSuccess — the successful user authentication callback.
onError — the request error callback.
onCancel — the user authentication cancellation callback, triggered when the user closes the widget without completing the authentication process.
locale — the UI language (optional). The following languages are supported: Arabic (ar_AE), Bulgarian (bg_BG), Czech (cz_CZ), English (en_US), German (de_DE), Spanish (es_ES), French (fr_FR), Hebrew (he_IL), Italian (it_IT), Japanese (ja_JP), Korean (ko_KR), Polish (pl_PL), Portuguese (pt_BR), Romanian (ro_RO), Russian (ru_RU), Thai (th_TH), Turkish (tr_TR), Vietnamese (vi_VN), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW).

For standalone builds, the widget opens in the built-in browser that is included with the SDK. You can use a different built-in browsing solution that allows you to track URL changes

For general instructions on installing and using the SDK, see documentation of enterprise-level SDK for Unreal Engine.

Install SDK

Download the Epic Games Launcher.
Create a new Unreal Engine project.

Download and install the SDK:
1. To download and install the SDK from the Unreal Engine Marketplace:
  1. Go to the SDK page on the Unreal Engine Marketplace.
  2. Click Open in Launcher.

1. 1. Go to Epic Games Launcher.

1. 1. Click Install to Engine.
  2. Open your Unreal Engine project in Unreal Editor.
  3. Go to the Settings > Plugins > Installed > Xsolla SDK section. Check the Enabled box and click Restart Now to save settings and reload the Unreal Editor.

1. To download and install the SDK from GitHub:
  1. Download the package with the SDK for your version of the engine.
  2. Unzip the package.
  3. Move the SDK folder to the plugins directory in the root of your Unreal Engine project.

Set up SDK

Open your Unreal Engine project in Unreal Editor.
Go to Settings > Project Settings > Plugins > Xsolla Settings > General and specify project parameters:

1. In the Project ID field, specify the project ID that can be found in Publisher Account next to the name of your project.
2. In the Login ID field, specify the ID of the Login project. To get it, open Publisher Account, go to the Login > Dashboard > your Login project section, and click Copy ID next to the name of the Login project.
3. In the Client ID field, specify client ID for OAuth 2.0 that can be found in Publisher Account in the Login > your Login project > Security > OAuth 2.0 section.
4. In the Redirect URI field, specify the URL or path in the application to which users are redirected after they have successfully authenticated, confirmed their email, or reset their password. The value must match the one specified in Publisher Account in the Login > your Login project > Security > OAuth 2.0 section.
5. Set other settings if necessary (e.g., display options for the payment UI in the Pay Station UI section).

As a result, your project in Publisher Account will be connected to demo maps.

Go to Content Browser > View Options and check the boxes for Show Engine Content and Show Plugin Content.

Add Xsolla Login widget opening

Call the AuthWithXsollaWidget SDK method, passing the following parameters:

WorldContextObject — the world context object (for C++ call).
SuccessCallback — the successful user authentication and token receipt callback (optional).
CancelCallback — the user authentication cancellation callback, triggered when the user closes the widget without completing the authentication process (optional).
ErrorCallback — the callback for errors that occur during the authentication process (optional).
bRememberMe — whether it is necessary to retain the authentication data (optional). By default, the value is set to false.
Locale — the UI language (optional). By default, this value is defined by the user’s IP address.
State — a string used for additional verification of the user on the application server. The default value is set to xsollatest.

Example:

In standalone builds, the widget is opened using the W_LoginBrowser blueprint, which comes bundled with the SDK.

You can customize the existing blueprint to open the authentication widget.

Thank you for your feedback!

We’ll review your message and use it to help us improve your experience.

Last updated: December 20, 2024

Found a typo or other text error? Select the text and press Ctrl+Enter.

Contents

Connect Xsolla Login widget SDK
Initialize Xsolla Login widget SDK
Add Xsolla Login widget opening
Import package from an archive
Set up compiler
Set up SDK
Add Xsolla Login widget opening
Install SDK
Set up SDK
Add Xsolla Login widget opening

Your browser is not supported. Please try a different browser

Authenticate users in your application

Connect Xsolla Login widget SDK

Initialize Xsolla Login widget SDK

Add Xsolla Login widget opening

Import package from an archive

Set up compiler

Set up SDK

Add Xsolla Login widget opening

Install SDK

Set up SDK

Add Xsolla Login widget opening

How we use cookies