Configure native session sync

Last updated on April 18, 2024

Overview​

This guide will show you how to configure session sync with a first-party platform. This will allow you to integrate with game platforms such as Steam, Xbox, and PlayStation.

Goals​

  • Configure session sync for Steam
  • Configure session sync for Xbox
  • Configure session sync for PSN

Prerequisites​

Before you begin, you must have:

  • access to the AccelByte Gaming Services (AGS) Admin Portal
  • a namespace for your game
  • knowledge of session configuration

Configure session sync for Steam​

  1. Go to the Admin Portal and select Login Methods.

  2. Click Add New, then select Steam Web.

  3. Fill in the Steam Web API key. For more information on how to generate a key, check the Admin Portal documentation.

  4. Fill in the Redirect URI.

  5. Click Create. A successful result is displayed as follows:

    A successfully created Steam Web Login Configuration

note

A PSN native party invite is active for two hours before it expires, which is hardcoded into the backend.

Configure session sync for Xbox​

  1. Go to the Admin Portal and select Login Methods.

  2. Click Add New, then select XBox Web.

  3. Fill in the Client ID and Client Secret.

  4. Fill in the Redirect URI.

  5. Click Create. A successful result is displayed as follows:

    A successfully created Xbox Web Login Configuration

  6. Go to 3rd Party Store Integrations.

  7. Select Xbox then click Add Configuration.

  8. Upload the business partner certificate (BPC), then click Create.

  9. Create a new Xbox session template via https://partner.microsoft.com/en-US/xboxconfig/sessiontemplates/index?.

  10. Create a new session template and enable session sync.

  11. Fill in the Template Name and Config ID.

note

You can adjust readyRemovalTimeout (how long until "ready" members are reverted to inactive) and sessionEmptyTimeout (how long until a session is deleted after it becomes empty) as desired. See the Microsoft documentation for multiplayer sessions for more information.

Configure session sync for PlayStation​

  1. Go to the Admin Portal and select Login Methods.

  2. Click Add New, then select PSN 5 SDK.

  3. Fill the Client ID and Client Secret from PSN product page, and select the environment that you want to use.

  4. Fill in the Redirect URI.

  5. Click Create. A successful result is displayed as follows:

    A successfully created PSN 5 SDK Login Configuration

  6. Go to 3rd Party Store Integrations and fill in the Client ID, Client, and Scope.

    • ClientID: Auth Server (Client Credential) ClientID
    • ClientSecret: Auth Server (Client Credential) Secret
    • Scope: psn:s2s.service (For Sync non PSN member to PSN Session)

  7. Create a new session template and enable session sync.

  8. Fill the Session title, PSN Base URL, Supported Platform, and Service Label.

note

Steam does not provide information on invitation expirations. For more information, review their documentation on ILobbyMatchmakingService.

Last updated on

On this page