Overview

Welcome to the Backpack API, an essential tool to enhance your item-selling strategy and promotional campaigns.

With Backpack, users can store information about the items they purchased or received for free. When receiving items, users don’t need to use their game ID or go to the game from the distributor site — they can keep items in the Backpack and redeem them later.

All items purchased or received for free on the distributor website are available to the user in the Metaframe widget or Xsolla Wallet.

User flow:

1. The user visits the distribution site.
2. The user logs in through the Xsolla account in the Metaframe widget.
3. The user purchases the item or gets it for free and selects the option to move the item to the Backpack.
4. Information about the received item is transferred to the Backpack.
5. In the Metaframe widget or Xsolla Wallet, the user opens the Backpack section and selects the item.
6. The user receives the item.
7. Information about the received item is transferred to the game.

Features

• Item Storage: Users can store information about items purchased or received for free.
• Redemption Flexibility: Items stored in the Backpack can be redeemed at the user's convenience.

Getting Started

To get started with Backpack, check out our detailed guide on Setting up Backpack. This guide will walk you through the process of configuring Backpack to suit your needs.

Key Entities

Backpack revolves around three major entities:

1. Items: The core entities that can be distributed to users.
2. Game: The entity designed to combine items.
3. Backpack: The entity designed to to grant user items in the game.

Authorization

To interact with the Backpack API, you need to set up authorization.

For authorization, you have to provide 2 kinds of headers:

1. X-HOST-ID header.
2. Authorization header.

X-HOST-ID header

It is a unique header issued by Xsolla. To obtain it, please contact the integration team at integration@xsolla.com or your Customer Success Manager at csm@xsolla.com. Provide them with the project ID and merchant ID.

You can find the merchant ID parameter in your Publisher Account:

• in the Project settings > Webhooks section.
• in the Company settings > Company section.
• in the URL in the browser address bar on any Publisher Account page. The URL has the following format: https://publisher.xsolla.com/<merchant ID>/<Publisher Account section>.

You can find the project ID parameter in your Publisher Account next to the name of the project.

Authorization header

Set up user authentication via Xsolla account on Xsolla Wallet by following this guide. This process involves actions in the Publisher Account and assistance from our integration team.

Once the Xsolla account client is set up, use this endpoint to generate a token. The token is valid for 1 hour, after which you'll need to invoke the endpoint again for a new token.

Use the obtained token by providing the Authorization header with the Bearer token string.

Webhooks

Webhook notifications associated with the Backpack are listed under the Webhooks tag. For more in-depth information about working with webhooks, refer to our main webhook documentation.

To set up webhooks:

1. Open your project in the Publisher Account.
2. Click Project settings in the side menu and navigate to Webhooks.
3. Specify the URL where you want to receive webhooks in the https://example.com format.
4. A secret key to sign project webhooks is generated by default. To generate a new secret key, click the refresh icon.
5. Click Enable webhooks.

If you have set up a Metaframe webhook, please contact the integration team at integration@xsolla.com or your Customer Success Manager at csm@xsolla.com. They will assist you in setting up a second webhook for the project.