Xsolla servers integration

With this type of integration, the following tasks are performed on the Xsolla side:

  • Catalog storage and management
  • Price management
  • Storing data on regional prices
  • Regional restrictions management
  • Inventory management
  • Promotional campaign management
  • User authentication
  • User access management
  • Transaction processing

You don’t need to configure your own server for these tasks.

Integration flow

To integrate with Xsolla servers using the Game Commerce plug-in:

  1. Install the plug-in.
  2. Set up the project in your Publisher Account.
  3. Set up Login or implement your own authorization system using the Pay Station access token.
  4. Set up the Virtual Currency module (optional).
  5. Set up the Virtual Items module.
  6. Set up your UE4 project.

After the integration is complete, test the payment process.

Contact our integration team
Click the chat icon in the bottom right corner and contact the integration team via a messenger. We’ll answer you in real time and will help to resolve the problem.
Note
This guide describes the minimum settings required to quick-start the module. For any questions, contact your Account Manager or email at integration@xsolla.com.

Install plug-in

  1. Download the Epic Games Launcher.
  2. Create a new UE4 project.
  3. Download plug-in from Unreal Engine Marketplace or GitHub.

After installing the plug-in, launch demo maps from the Content Browser > Xsolla Content > Maps directory. Demo maps show the features of the plug-in and represent a possible implementation of the application logic.

For demo maps, a project in Publisher Account is preset and an in-game store is fully configured.

Default values for demo maps:

KeyValue
Login ID026201e3-7e40-11ea-a85b-42010aa80004
Project ID77640

You can use demo maps in two ways:

  • as an example
  • as an initial version of the login system, inventory, and in-game store in order to get a quick result and expand its capabilities if necessary

Create project in Publisher Account

  1. Sign up to Publisher Account.
  2. Configure your project:
    1. To fill in the game data automatically, provide the Link to your game on any platform. This adds an image of the game, its name, and description to the project settings.
    2. To fill in the game data manually, click I don’t have a link, set up manually and specify:
      • Project languages (default: English)
      • Project name for all specified languages
      • Game website (optional)
    3. Click Create project.

During the integration process, you need to provide the project ID that can be found in your Publisher Account next to the name of your project.

Set up basic Login project

  1. Open your project in Publisher Account.
  2. Click Connect in the Login pane or select Login in the side menu.
  3. Click Create Login project.

  1. Select Standard Login project and click Create and set up. Wait until your new Login project is created. Then you will see the project settings navigation page.
  2. In the Login methods block on the navigation page, select the method that suits your game best and click Configure.

  1. The Login product offers three options for your games:
    • Classic login
      Users log into the game by providing their username and password. In addition, users can log in using one of their social networks.
    • Passwordless login
      Users log into the game using one-time codes or links sent to their email address or phone number. Login via social networks is also supported.
    • Social login
      Users enter the game only through social networks.

  1. In the top settings block on the navigation page, click Callback URLs and set the following parameters:
    • Callback URL — the URL or path in the application to which users are redirected after they have successfully authenticated, confirmed their email, or reset their password. You can specify multiple valid URLs.
    • Error callback URL — the URL or path in the application to which users are redirected in case of an authentication error. If no value is specified, the Callback URL value will be used.

  1. Click Save changes.

  1. Set up a social login (optional):
    1. Click the name of your Login project in breadcrumb navigation to return to the navigation page.
    2. Go to the Authentication block and select the Social login section.
    3. Connect social networks that users will be able to use to sign up and log into the application:

      • To connect the desired social network, click the ⚙ icon and select Connect.

      • To connect several social networks at once, select the required panes (their borders will turn green). Then, from the Manage drop-down menu, select Connect.

      • To connect all available social networks at once, click Select all. Then, from the Manage drop-down menu, select Connect.

  1. Set up OAuth 2.0 authentication:
    1. Click the name of your Login project in breadcrumb navigation to return to the navigation page.
    2. Go to the Security block and select the OAuth 2.0 section.
    3. Click Add OAuth 2.0.
    4. Specify OAuth 2.0 redirect URIs and click Connect.
    5. Copy and save the Client ID.

  1. Change the user data storage (optional). By default, user data is stored and processed on the Xsolla’s side. If you want to connect PlayFab, Firebase, or your own custom storage, follow the instructions: Connect user data storage.

During the integration process, you will need the following parameters:

  • Login ID. To get it, open Publisher Account, go to the Login > Dashboard section, and click Copy ID beside the name of the Login project.

  • Client ID. It can be found in Publisher Account in the Login > your Login project > Security > OAuth 2.0 section.

Set up Virtual Currency module

  1. Open your project in Publisher Account.
  2. Click Connect in the Store pane. You can go to the In-Game Store settings from any section of Publisher Account by clicking the Store in the side menu.

  1. Click Connect in the Virtual Currency pane.

  1. Create virtual currency:
    1. Click Create virtual currency.

    1. Specify the following information:
      • SKU
      • currency name
      • price of one unit of virtual currency
      • default currency
      • features of hard virtual currency (optional)
      • image (optional)
    2. Click Create currency.

  1. Create packages of virtual currency:
    1. Go to Packages.
    2. Click Create package.

    1. Specify the following information:
      • SKU
      • package name
      • short description
      • virtual currency
      • quantity of currency units in a package
      • price
      • default currency
      • image (optional)

    1. Set the Show in Store toggle to On.
    2. Click Create package.

Note
The plug-in supports purchasing of virtual items for virtual currency. Also, the users are able to use virtual currency according to in-game logics (getting access to a location, getting progression levels, etc.). Users spend virtual currency when calling a ConsumeInventoryItem SDK method.

Set up Virtual Items module

Note
The SDK methods support the following types of items:
  • Consumable item — an item in the inventory that can be accrued or purchased repeatedly and decreases in its number once used. The item stock can be replenished. Example: grenades and bullets to attack the opponents, first aid kits, etc.
  • Nonconsumable — an item in the inventory that can be accrued or purchased only once and doesn’t disappear from the inventory. Example: access to a location, status, etc.
  • Nonrenewing subscription — a nonconsumable item that is available for a limited period of time and doesn’t disappear from the inventory when it expires. For example, premium access or season access. For more details, see In-Game Store documentation.

  1. Open your project in Publisher Account.
  2. Click Connect in the Store pane. You can go to the In-Game Store settings from any section of Publisher Account by clicking the Store in the side menu.

  1. Click Connect in the Virtual Items pane.

  1. Click Create a group.

  1. Specify Group code and Group name.
  2. Set the Show group in Store toggle to On.
  3. Click Create group.

  1. Create items:
    1. Specify the following info for each of them:
      • one or more groups that the item should belong to
      • SKU
      • name and a short description
      • prices in real and virtual currencies
      • image (optional)

    1. In the Item property field of the Preferences section, select one of the following properties depending on the type of item:
      • consumable
      • nonconsumable
      • nonrenewing subscription
    2. Click Create an item.

  1. Make sure that the group status is Enabled.

Set up UE4 project

  1. Open your UE4 project in Unreal Editor.
  2. For Blueprint projects only:
    1. Compile your UE4 project.
    2. Go to the Content Browser and add a New C++ Class with the None parent node.
  3. Go to Settings > Plugins > Installed > Xsolla Store SDK. Check the Enabled box and click the Restart Now button to save settings and reload the Unreal Editor.

  1. Specify project parameters:
    1. Go to Settings > Project Settings > Plugins > Xsolla Login and specify the following parameters:

      1. In the Login ID and Demo Login ID fields, specify the Login ID from Publisher Account.
      2. In the Project ID and Demo Project ID fields, specify the Project ID from Publisher Account.
      3. Enable Use OAuth 2.0 option.
      4. In the Client ID field, specify Client ID received when setting up OAuth 2.0 in Publisher Account.

Note
If you use your own authorization system, you do not need to fill in Login ID and Demo Login ID fields.

    1. Go to Settings > Project Settings > Plugins > Xsolla Store and specify the Project ID in the Project ID and Demo Project ID fields.

    1. Go to Settings > Project Settings > Plugins > Xsolla Inventory and specify the Project ID in the Project ID and Demo Project ID fields.

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

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

  1. Go to Content Browser > Xsolla Content > Maps and launch the Demo_Store map of the game. Make sure that the authorization and other functions are working correctly.
  2. Design an interface for the login system, in-game store, and other pages for your application.

Note
You can create your own solution by following UMG UI documentation, or use the demo scene as a template. To adapt the demo scene interface to your application, use the UI builder.

  1. Set up event handling according to your application logic using SDK methods. Follow the step-by-step tutorials to get started with basic SDK features.

Note
To modify the SDK for your application specifics, follow the SDK modification instruction.

Test payment process

After successfully configuring the plug-in, test the payment process. By default, all payments are in sandbox mode for any users. Use a test bank card to simulate a successful payment process.

Test the payment process by making real payments:

  1. Make sure that you have signed a contract with Xsolla.
  2. In your UE4 project, uncheck the Sandbox box in Settings > Project Settings > Plugins > Xsolla Store.

Note
After the first real payment is made, a strict sandbox payment policy takes effect. A payment in the sandbox mode is available only to users who are specified in Publisher Account > Company settings > Users.
Was this article helpful?
Thank you!
Is there anything we can improve? Message
We’re sorry to hear that
Please explain why this article wasn’t helpful to you. Message
Thank you for your feedback!
We’ll review your message and use it to help us improve your experience.
Rate this page
Rate this page
Is there anything we can improve?

Don’t want to answer

Thank you for your feedback!

Continue reading

Last updated: May 6, 2022

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

Report a problem
We always review our content. Your feedback helps us improve it.
Provide an email so we can follow up
Thank you for your feedback!