Authentication

Follow the step-by-step tutorials below to get going with the basic SDK features.

User login via username/email and password

This instruction shows how to use SDK methods to implement:

  • user sign-up
  • resend request for a sign-up confirmation email
  • user login
  • user password reset

You can authenticate users with their username or email address. In the following examples we authenticate users with their username, whereas the email address is used to confirm sign-up and to reset the password.

Note
If you use the Login widget on your site (in a web store, for example), make sure that you implemented the same user authentication methods on your site and in your application. The widget uses the email address for authentication by default. To set up user login via username, contact your Account Manager.

The logics and interface in the examples are less complicated than they will be in your application. A possible authentication system implementation option is described in the demo project.

Implement user sign-up

Create page interface

Create a scene for a sign-up page and add the following elements on it:

  • username field
  • user email address field
  • user password field
  • sign-up button

The following picture shows the example of a page structure.

Create page controller

  1. Create a script RegistrationPage inherited from the MonoBehaviour base class.
  2. Declare variables for the page interface elements and set values for them in the Inspector panel.
  3. Add logics to process clicking on the sign-up button:

    1. In the Start method, subscribe to a clicking event.
    2. Add an anonymous method that is called after clicking the button.
    3. In this method, declare the username, email, and password variables and initialize them by the values from the fields on the page.
    4. Call the XsollaLogin.Instance.Registration SDK method and pass the username, email, and password variables and the following methods to it:

      • OnSuccess — called if sign-up is successful
      • OnError — called if an error occurs

Note

In the script’s examples, the OnSuccess and OnError methods call the standard Debug.Log method. The error code and description are passed in the error parameter.

You can add other actions like opening a page with a resend request for a sign-up email or opening a login page if sign-up is successful.

Example of a script for a sign-up page:

Copy
Full screen
Small screen
using UnityEngine;
using UnityEngine.UI;
using Xsolla.Core;
using Xsolla.Login;

namespace Recipes
{

  public class RegistrationPage : MonoBehaviour
  {
    // Declaration of variables for UI elements on the page

    [SerializeField] private InputField UsernameInput;

    [SerializeField] private InputField EmailInputField;

    [SerializeField] private InputField PasswordInputField;

    [SerializeField] private Button RegisterButton;

    private void Start()
    {
      // Handling the button click
      RegisterButton.onClick.AddListener(() =>
      {
        var username = UsernameInput.text;
        var email = EmailInputField.text;
        var password = PasswordInputField.text;

        XsollaLogin.Instance.Registration(username, email, password, OnSuccess, OnError);
      });
    }

    private void OnSuccess()
    {
      UnityEngine.Debug.Log("Registration successful");
      // Some actions
    }

    private void OnError(Error error)
    {
      UnityEngine.Debug.Log($"Registration failed. Description: {error.errorMessage}");
      // Some actions
    }
  }
}

Set up sign-up confirmation email

After successful sign-up, a user receives a sign-up confirmation email to a specified address. You can customize emails sent to users in Publisher Account.

If you are developing an Android application, set up deep links to return a user to an application after they confirm sign-up.

Note
You can disable sign-up confirmation via an email address if your security standards allow you to do this. Contact your Account Manager to disable it or contact us at am@xsolla.com.

Implement sign-up confirmation email resend request

Create page interface

Create a scene for a page with a request to resend a confirmation email and add the following elements to it:

  • username/email field
  • resend button

The following picture shows an example of a page structure.

Create page controller

  1. Create a script ResendConfirmationEmail inherited from the MonoBehaviour base class.
  2. Declare variables for page interface elements and set values for them in the Inspector panel.
  3. Add logics to process clicking on the email resend button:

    1. In the Start method, subscribe to a clicking event.
    2. Add an anonymous method that is called after clicking the button.
    3. In this method, declare the username variable and initialize it by the values from the fields on the page.
    4. Call the XsollaLogin.Instance.ResendEmail SDK method and pass the username variable and OnSuccess and OnError methods to it.

Example of a script for an email resend page:

Copy
Full screen
Small screen
using UnityEngine;
using UnityEngine.UI;
using Xsolla.Core;
using Xsolla.Login;

namespace Recipes
{
  public class ResendConfirmationEmail : MonoBehaviour
  {
    // Declaration of variables for UI elements on the page

    [SerializeField] private InputField UsernameInput;

    [SerializeField] private Button ResendEmailButton;

    private void Start()
    {
      // Handling the button click
      ResendEmailButton.onClick.AddListener(() =>
      {
        var username = UsernameInput.text;

        XsollaLogin.Instance.ResendEmail(username, OnSuccess, OnError);
      });
    }

    private void OnSuccess()
    {
      UnityEngine.Debug.Log("Resend confirmation email successful");
      // Some actions
    }

    private void OnError(Error error)
    {
      UnityEngine.Debug.Log($"Resend confirmation email failed. Description: {error.errorMessage}");
      // Some actions
    }
  }
}

If the request is successful, the user receives a sign-up confirmation email to the email address specified during sign-up.

Implement user login

Create page interface

Create a scene for a login page and add the following elements to it:

  • username field
  • password field
  • remember me checkbox
  • login button

The following picture shows an example of a page structure.

Create page controller

  1. Create a script AutorizationPage inherited from the MonoBehaviour base class.
  2. Declare variables for page interface elements and set values for them in the Inspector panel.
  3. Add logics to process clicking on the login button:

    1. In the Start method, subscribe to a clicking event.
    2. Add an anonymous method that is called after clicking the button.
    3. In this method, declare the username and password variables and initialize them by the values from the fields on the page. Create a rememberMe variable and initialize it with a checkbox state to remember an account.
    4. Call the XsollaLogin.Instance.SignIn SDK method and pass the username, password, and rememberMe variables and OnSuccess and OnError methods to it.

Note
After successful user login, the authorization token is passed in the token parameter. The authorization token is used in requests to Xsolla servers.

Example of a script for a login page:

Copy
Full screen
Small screen
using UnityEngine;
using UnityEngine.UI;
using Xsolla.Core;
using Xsolla.Login;

namespace Recipes
{
  public class AuthorizationPage : MonoBehaviour
  {
    // Declaration of variables for UI elements on the page

    [SerializeField] private InputField UsernameInput;

    [SerializeField] private InputField PasswordInputField;

    [SerializeField] private Toggle RememberMeToggle;

    [SerializeField] private Button AuthorizationButton;

    private void Start()
    {
      // Handling the button click

      AuthorizationButton.onClick.AddListener(() =>
      {
        var username = UsernameInput.text;
        var password = PasswordInputField.text;
        var rememberMe = RememberMeToggle.isOn;

        XsollaLogin.Instance.SignIn(username, password, rememberMe, OnSuccess, OnError);
      });
    }

    private void OnSuccess(string token)
    {
      UnityEngine.Debug.Log($"Authorization successful. Token: {token}");
      // Some actions
    }

    private void OnError(Error error)
    {
      UnityEngine.Debug.Log($"Authorization failed. Description: {error.errorMessage}");
      // Some actions
    }
  }
}

Implement password reset

Create page interface

Create a scene for a password reset page and add the following elements to a page:

  • username/email field
  • password reset button

The following picture shows an example of a page structure.

Create page controller

  1. Create a script ResetPasswordPage inherited from the MonoBehaviour base class.
  2. Declare variables for page interface elements and set values for them in the Inspector panel.
  3. Add logics to process clicking on the password reset button:

    1. In the Start method, subscribe to a clicking event.
    2. Add an anonymous method that is called after the button is clicked.
    3. In this method, declare the username variable and initialize it by the values from the fields on the page.
    4. Call the XsollaLogin.Instance.ResetPassword SDK method and pass the username variables and OnSuccess and OnError methods to it.

Example of a script for a password reset page:

Copy
Full screen
Small screen
using UnityEngine;
using UnityEngine.UI;
using Xsolla.Core;
using Xsolla.Login;

namespace Recipes
{
    public class ResetPasswordPage : MonoBehaviour
    {
        // Declaration of variables for UI elements on the page

        [SerializeField] private InputField UsernameInput;

        [SerializeField] private Button ResetPasswordButton;

        private void Start()
        {
            // Handling the button click

            ResetPasswordButton.onClick.AddListener(() =>
            {
                var username = UsernameInput.text;

                XsollaLogin.Instance.ResetPassword(username, OnSuccess, OnError);
            });
        }

        private void OnSuccess()
        {
            UnityEngine.Debug.Log("Password reset successful");
            // Some actions
        }

        private void OnError(Error error)
        {
            UnityEngine.Debug.Log($"Password reset failed. Description: {error.errorMessage}");
            // Some actions
        }
    }
}

After successful password reset request, the user receives an email with a password reset link. You can configure a redirection address in Publisher Account > your Login project > General settings > URL > Callback URL.

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.
Hide

Social login

This guide shows how you can use SDK methods to implement user sign-up and login via their social network account.

Unlike for user authentication via username/user email address and password, you don’t have to implement separate logics for user sign-up. If the user’s first login is via a social network, a new account is created automatically.

If you have implemented social login in your application as an alternative authentication method, the social network account automatically links to an existing user account if the following conditions are met:

  • A user who signed up with username/email address and password logged into your application via a social network account.
  • A social network returns an email address.
  • User email address in a social network is the same as the email address used for sign-up in your application.

Note
You can implement manual linking of a social network account. Add the page to your application where users can link a social network account to their account. In the page controller, use the LinkSocialProvider SDK method.

The examples show how to set up user login via a Facebook account. You can set up all social networks in the same way.

The logics and interface in the examples are less complicated than they will be in your application. A possible authentication system implementation option is described in the demo project.

Create page interface

Create a scene for a login page and add the social login button to it. The following picture shows an example of the page structure.

Create page controller

  1. Create a script SocialAuthorizationPage inherited from the MonoBehaviour base class.
  2. Declare variables for the application login page interface elements and set values for them in the Inspector panel.
  3. Add logics to process clicking on the login button:

    1. In the Start method, subscribe to a clicking event.
    2. Add an anonymous method that is called after clicking the button.
    3. To pass a login page URL, declare the url variable in an anonymous method. Initialize this variable by the GetSocialNetworkAuthUrl SDK method by passing a Facebook value in the SocialProvider parameter.
    4. To open a browser, call the BrowserHelper.Instance.Open method. To use a built-in browser, pass the url variable and a true value to the method.

Note
Social login isn’t available for external browsers. SDK contains a built-in browser developed by Xsolla. You can use either an Xsolla built-in browser or a different built-in browsing solution.

    1. To get a token and close the browser, track the changes of the page URL after successful user sign-up:
      1. Declare a singlePageBrowser variable and initialize it via the BrowserHelper.Instance.GetLastBrowser SDK method.
      2. Subscribe to an active page URL changing event and set the OnUrlChanged method as a handler.

  1. Implement getting of the token:
    1. Use a ParseUtils.TryGetValueFromUrl utility method to parse a URL of an active page passed in the OnUrlChanged method.
    2. Add a check for an authentication code in an active page URL. The ParseUtils.TryGetValueFromUrl method passes an authentication code in the code variable.
    3. To exchange an authentication code for a token, call the ExchangeCodeToToken SDK method and pass a code variable and the following methods to it:
      • OnSuccess — called if sign-up is successful
      • OnError — called if an error occurs

Note

In the script’s examples, the OnSuccess and OnError methods call the standard Debug.Log method. You can add other actions.

If a user successfully logs in, the authorization token is passed in the token parameter. This token is used in requests to Xsolla servers. If an error occurs, its code and description are passed in the error parameter.

    1. After you get the token, delete a game object with a browser.

Example of a script for a login page:

Copy
Full screen
Small screen
using UnityEngine;
using UnityEngine.UI;
using Xsolla.Core;
using Xsolla.Login;

namespace Recipes
{
    public class SocialAuthorizationPage : MonoBehaviour
    {

        // Declaration of variables for UI elements on the page

        [SerializeField] private Button FacebookButton;

        private void Start()
        {

            // Handling the button click

            FacebookButton.onClick.AddListener(() =>
            {

                // Opening browser

                var url = XsollaLogin.Instance.GetSocialNetworkAuthUrl(SocialProvider.Facebook);
                BrowserHelper.Instance.Open(url, true);

                // Determining the end of authentication

                var singlePageBrowser = BrowserHelper.Instance.GetLastBrowser();
                singlePageBrowser.GetComponent<XsollaBrowser>().Navigate.UrlChangedEvent += OnUrlChanged;
            });
        }


        // Getting token

        private void OnUrlChanged(IXsollaBrowser browser, string url)
        {
            if (ParseUtils.TryGetValueFromUrl(url, ParseParameter.code, out var code))
            {
                XsollaLogin.Instance.ExchangeCodeToToken(code, OnSuccess, OnError);
                Destroy(BrowserHelper.Instance.gameObject);
            }
        }

        private void OnSuccess(string token)
        {
            UnityEngine.Debug.Log($"Authorization successful. Token: {token}");
            // Some actions
     }

        private void OnError(Error error)
        {
            UnityEngine.Debug.Log($"Authorization failed. Description: {error.errorMessage}");
            // Some actions
     }
    }
}

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.
Hide
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!
Last updated: June 17, 2021

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!