跳转到内容

概述

  • 版本: 2.0.0
  • 服务器https://store.xsolla.com/api
  • 通过邮件联系我们
  • 联系URL: https://xsolla.com/
  • 必需的TLS版本: 1.2

LiveOps运营API是一套工具包,通过促销活动和个性化优惠推动玩家持续互动。

通过该API可管理以下功能:

  • 促销活动 — 创建和管理优惠券、促销码、折扣及奖励活动。
  • 个性化 — 指定商品目录显示和促销活动应用条件,仅面向特定授权用户。
  • 促销活动限制 — 设置用户使用促销活动的次数限制,并配置限制的定期重置。
  • 奖励链和奖励积分 — 配置与奖励积分累积关联的奖励进度。
  • 每日奖励链 — 设置循环每日奖励,激励玩家定期登录。
  • 优惠链 — 创建阶梯式连续购买优惠,每步提供不同定价和免费奖励选项。
  • 追加销售 —向用户提供购买超值商品的销售方式。

API调用

API分为以下组别:

  • Admin — 用于创建、更新、激活和删除营销活动及奖励链配置。通过基本认证方式验证身份,需使用您的商户或项目凭据。
  • Client — 用于检索可用促销活动、获取活跃奖励链、兑换码,以及代表最终用户(已完成身份认证)领取奖励。通过用户JWT进行身份认证。
下载 OpenAPI 描述
语言
服务器
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/zh/api/liveops/
操作

优惠券

此API让您可以管理优惠券。

操作

促销码

此API让您可以管理促销码。

操作

特别目录优惠

此API让您可以管理特别目录优惠活动。

操作

折扣

此API让您可以管理折扣促销活动。

操作

奖励

此API让您可以管理奖励促销活动。

操作

个性化目录

此API可让您针对用户属性指定规则。如果用户满足具体规则的所有条件,则会显示个性化商品。

有关个性化促销活动的信息,请参阅促销活动部分

要在购买前传递属性,您可以使用艾克索拉Login API或在使Pay Station API生成令牌时将它们传入user.attributes属性

操作
操作
操作
操作

获取当前用户的奖励链Client-side

请求

客户端端点。获取当前用户的奖励链。

注意:

所有项目对于可以在响应中获得的商品数量均都限制。默认值和最大值是每个响应50项。要逐页获取更多数据,请使用limitoffset字段。
安全
XsollaLoginUserJWT
路径
project_idinteger必需

项目ID。您可以在您的发布商帐户项目名称旁边找到。

示例: 44056
查询
limitinteger>= 1

页面上元素数量的限制。

示例: limit=50
offsetinteger>= 0

元素编号,从该元素开始生成列表(从0开始数)。

示例: 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>'

响应

成功获取用户的奖励链。

正文application/json
has_moreboolean

用作指示还有更多页面。

示例: true
itemsArray of objects(client-reward-chain-item-model)
total_items_countinteger

系统中奖励链的总数。

示例: 10
响应
application/json
{ "has_more": false, "items": [ {}, {} ], "total_items_count": 1 }

获取当前用户的奖励积分余额Client-side

请求

客户端端点。获取当前用户的奖励积分余额。

安全
XsollaLoginUserJWT
路径
project_idinteger必需

项目ID。您可以在您的发布商帐户项目名称旁边找到。

示例: 44056
reward_chain_idinteger必需

奖励链ID。

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

响应

已成功获取用户的奖励积分余额。

正文application/json
amountinteger

奖励积分数量。

descriptionstring or null(value-point-description)

奖励积分描述。

image_urlstring(Common_admin-image_url)

图像URL。

示例: "https://image.example.com"
is_clanboolean(is_clan)

该奖励积分是否用于公会奖励链。

示例: true
long_descriptionstring or null(value-point-long-description)

奖励积分详细描述。

namestring(value-point-name)

奖励积分名称。

skustring(value-point-sku)

唯一奖励积分ID。

响应
application/json
{ "amount": 80, "description": "Value points for clan reward system.", "image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png", "is_clan": true, "long_description": "Value points given to clans to get new rewards in a reward chain.", "name": "Clan Reward VP 1", "sku": "com.xsolla.clan_value_point_1" }

请求

客户端端点。从奖励链中领取当前用户的步骤奖励。

安全
XsollaLoginUserJWT
路径
project_idinteger必需

项目ID。您可以在您的发布商帐户项目名称旁边找到。

示例: 44056
reward_chain_idinteger必需

奖励链ID。

示例: 101
step_idinteger必需

奖励链步骤ID。

示例: 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>'

响应

成功从奖励链中领取当前用户的步骤奖励。

响应
无内容
操作
操作
操作
操作
操作
操作
操作