Skip to content
/
Get current user's value...

LiveOps API (2.0.0)

Overview

  • Version: 2.0.0
  • Servers: https://store.xsolla.com/api
  • Contact Us by Email
  • Contact URL: https://xsolla.com/
  • Required TLS version: 1.2

LiveOps is a toolkit for driving ongoing player engagement through promotions and personalized offers.

Use the API to manage the following features:

  • Promotions — create and manage coupons, promo codes, discounts, and bonus campaigns.
  • Personalization — specify the conditions for displaying the item catalog and applying promotions only for certain authorized users.
  • Promotion limits — set a limit on how many times a promotion can be used by a user and configure scheduled resets for these limits.
  • Reward chains & Value points — configure reward progressions tied to value point accumulation.
  • Daily chains — set up recurring daily rewards to motivate regular logins.
  • Offer chains — build sequential purchase offers with per-step pricing and free reward options.
  • Upsell — a sales method in which the user is offered to buy an item with additional value.

API calls

The API is divided into the following groups:

  • Admin — calls for creating, updating, activating, and deleting campaigns and chain configurations. Authenticated via basic access authentication with your merchant or project credentials.
  • Client — calls for retrieving available promotions, getting active chains, redeeming codes, and claiming rewards on behalf of authenticated end users. Authenticated via user JWT.
Download OpenAPI description
index.json
index.yaml
Languages
Servers
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/api/liveops/

Common

Operations

Coupons

This API allows to you to manage coupons.

Operations

Promo codes

This API allows to manage promo codes.

Operations

Unique catalog offers

This API allows to you to manage unique catalog offers.

Operations

Discounts

This API allows to you to manage discount promotions.

Operations

Bonuses

This API allows to manage bonus promotions.

Operations

Personalized catalog

This API allows to specify rules for user attributes. If the user meets all conditions for a concrete rule, personalized items will be shown.

For personalized promotions see Promotions section.

To pass attributes before a purchase, you can use Xsolla Login API or pass them into user.attributes property while generating token using Pay Station API.

Operations

Management

Operations

Admin

Operations

Client

Operations

Get current user's reward chainsClient-side

Request

Client endpoint. Gets the current user’s reward chains.

Attention

All projects have the limitation to the number of items that you can get in the response. The default and maximum value is 50 items per response. To get more data page by page, use limit and offset fields.
Security
XsollaLoginUserJWT
Path
project_idintegerrequired

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

Example: 44056
Query
limitinteger>= 1

Limit for the number of elements on the page.

Example: limit=50
offsetinteger>= 0

Number of the element from which the list is generated (the count starts from 0).

Example: offset=0
curl -i -X GET \
  'https://store.xsolla.com/api/v2/project/44056/user/reward_chain?limit=50&offset=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The user’s reward chain was successfully retrieved.

Bodyapplication/json
has_moreboolean

Used as an indicator that there are more pages.

Example: true
total_items_countinteger

Total number of reward chains in the system.

Example: 10
itemsArray of objects(client-reward-chain-item-model)
Response
application/json
{
  "has_more": false,
  "total_items_count": 1,
  "items": [
    { … },
    { … }
  ]
}

Get current user's value point balanceClient-side

Request

Client endpoint. Gets the current user’s value point balance.

Security
XsollaLoginUserJWT
Path
project_idintegerrequired

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

Example: 44056
reward_chain_idintegerrequired

Reward chain ID.

Example: 101
curl -i -X GET \
  https://store.xsolla.com/api/v2/project/44056/user/reward_chain/101/balance \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The user’s value point balance was successfully retrieved.

Bodyapplication/json
skustring(value-point-sku)

Unique value point ID.

namestring(value-point-name)

Value point name.

image_urlstring(Common_admin-image_url)

Image URL.

Example: "https://image.example.com"
descriptionstring or null(value-point-description)

Value point description.

long_descriptionstring or null(value-point-long-description)

Value point long description.

amountinteger

Value point quantity.

is_clanboolean(is_clan)

Whether the value point is used in clan reward chains.

Example: true
Response
application/json
{
  "sku": "com.xsolla.value_point_1",
  "name": "Value point",
  "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
  "description": null,
  "long_description": null,
  "amount": 130,
  "is_clan": false
}

Claim step rewardClient-side

Request

Client endpoint. Claims the current user’s step reward from a reward chain.

Security
XsollaLoginUserJWT
Path
project_idintegerrequired

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

Example: 44056
reward_chain_idintegerrequired

Reward chain ID.

Example: 101
step_idintegerrequired

Reward chain step ID.

Example: 120
curl -i -X POST \
  https://store.xsolla.com/api/v2/project/44056/user/reward_chain/101/step/120/claim \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successfully claimed the current user's step reward from a reward chain.

Response
No content

Clans client

Operations

Admin

Operations

Client

Operations

Admin

Operations

Client

Operations

Admin

Operations

Client

Operations