Get started

Integrating with Xsolla servers is suitable for partners who want a ready-made server solution for monetization and in-game items management.

After integration of Xsolla SDKs, you can use:

With this integration, all operations are processed on the Xsolla side and you do not have to configure your own server side for these tasks.

Choose and install one of the following plugins depending on your needs:

  • Store UE4 SDK — contains all the necessary methods to integrate all Xsolla products listed above.
  • Login UE4 SDK — designed to implement only the functions of the Xsolla Login.
  • Inventory UE4 SDK — designed to implement functions of the Xsolla Login and the Player Inventory. Use this plugin if your application is published on a platform that cannot use the Xsolla Pay Station and In-Game Store for some reason.

Notice
All plugins are not compatible with each other. Choose and integrate only one plugin that best suits your needs.

Requirements

System requirements

  • 64-bit OS
  • Windows 7 and higher
  • macOS 10.13.6 and higher
  • XCode 11.1 and higher (for macOS)
  • Visual Studio 2017 and higher
  • Unreal Engine 4.25 and higher

Target OS

  • iOS
  • Android
  • macOS
  • Windows 64-bit
Note
To modify the SDK for your application specifics, follow the SDK modification instruction.

Features

Login UE4 SDK features

The Login UE4 SDK is used to integrate applications based on Unreal Engine with Xsolla Login. Main features:
  • authentication via username and password
  • authentication via social networks
  • authentication via Steam session_ticket
  • signup
  • email confirmation
  • password reset
  • user attributes management
  • cross-platform account linking
  • token invalidation
  • OAuth 2.0 support
  • friend system
  • user account

Inventory UE4 SDK features

The Inventory UE4 SDK is used to integrate applications based on Unreal Engine with the Xsolla Login and Player Inventory. The Inventory UE4 SDK supports all Login UE4 SDK features and additionally the following features:
  • managing user inventory
  • managing virtual currency balance
  • working with coupons
  • managing cross-platform inventory

Store UE4 SDK features

The Store UE4 SDK is used to integrate applications based on Unreal Engine with the following Xsolla products:The Store UE4 SDK supports all Login UE4 SDK and Inventory UE4 SDK features and additionally the following features:
  • selling virtual items
  • selling virtual currency
  • managing in-game store
  • working with promotional campaigns (discounts, coupons, promo codes)

Note
To enable cross-platform account linking, email the Xsolla integration team (integration@xsolla.com). Follow the account linking how-to to try this function in the demo.

Privacy policy

If you use the SDK, add the Xsolla Privacy Policy Agreement link to your application. You can see the example of this link in the demo project on the sign up page.

Note
Note that the Xsolla Privacy Policy Agreement doesn’t mean user data will be used. If you plan to collect and process this kind of data, make sure that your actions comply with the law. You should ask users for their permission to collect and process their data or inform them about the Privacy Policy Agreement.

Charge policy

Xsolla offers the necessary tools to help you build and grow your gaming business, including personalized support at every stage. The terms of payment are determined by the contract that can be signed via Publisher Account.

The cost of using all Xsolla products is 5% of the amount you receive for the sale of the game and in-game goods via the Xsolla Pay Station. If you do not use the Xsolla Pay Station in your application, but use other products, contact your Account Manager to clarify the terms and conditions.

Prerequisites

Before integrating Unreal Engine SDKs, follow these steps:

  1. Install the plugin.
  2. Set up the project in your Publisher Account.

Install the plugin

  1. Download the Epic Games Launcher.
  2. Create a new UE4 project.
  3. Download one of the plugins:

After installing the plugin, launch demo maps, that show how SDKs features work.

Set up the project in your Publisher Account

  1. Register an Xsolla Publisher Account.
  2. Configure a Publisher Account project that is automatically created after the previous step:
    1. Click My game in the Projects block and go to Project settings.
    2. In setup mode, specify a Project name and click Save.

    1. Go to Integration settings and check that the Integrate Commerce API toggle is set to On.

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

  • Project ID found in Project settings > Project ID.

  • Login ID found in Login settings > Login ID. It has the UUID format.

Demo

The integration demo is available in the Content Browser > Content > Maps folder. Use it as an example.

By default, the demo uses the Xsolla Project ID and Login ID of a preset Publisher Account project that has a fully configured store.

Default values for the demo maps:

KeyValue
Login ID026201e3-7e40-11ea-a85b-42010aa80004
Project ID77640
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.

Continue reading