跳转到内容

概述

  • 版本: 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属性

操作
操作
操作
操作
操作

获取公会名下奖励链的前10名贡献者列表Client-side

请求

检索当前用户公会名下指定奖励链的前10名贡献者列表。如果用户不属于任何公会,则该调用返回将为空数组。

安全
XsollaLoginUserJWT
路径
project_idinteger必需

项目ID。

示例: 44056
reward_chain_idinteger必需

奖励链ID。

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

响应

公会奖励链贡献者前10名列表。

正文application/jsonArray [
contributed_amountinteger

用户贡献的奖励积分数。

示例: 100
namestring

用户ID。这是授权过程中发送给艾克索拉的ID,用于将用户关联到您的艾克索拉登录管理器项目。

示例: "Rocket"
]
响应
application/json
[ { "contributed_amount": 555, "name": "winner" }, { "contributed_amount": 398, "name": "Rocket" }, { "contributed_amount": 201, "name": "MrJoe" }, { "contributed_amount": 1, "name": "beginner" } ]

更新当前用户的公会Client-side

请求

根据用户属性更新当前用户的公会。领取奖励链中在上一个公会未领取的所有奖励。如果用户之前在某个公会中,但现在不在,则其公会身份将被撤销。如果用户更改了公会,则公会将被更改。

安全
XsollaLoginUserJWT
路径
project_idinteger必需

项目ID。

默认值 44056
curl -i -X PUT \
  'https://store.xsolla.com/api/v2/project/{project_id}/user/clan/update' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

响应

成功更新了用户的公会。

正文application/json
rewardArray of objects
响应
application/json
{ "reward": [ {}, {} ] }
操作
操作
操作
操作
操作
操作