跳转到内容

概述

  • 版本: 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让您可以管理优惠券。

操作

获取唯一优惠券码限制Server-sideAdmin

请求

获取代码可以使用的剩余次数。要筛选代码,请使用codes查询参数。

要配置代码限制本身,请前往“管理”部分: *优惠券

安全
basicAuth
路径
project_idinteger必需

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

示例: 44056
external_idinteger必需

促销活动外部ID。项目内的唯一促销活动标识符。

示例: coupon_44056_1
查询
codes[]Array of strings

区分大小写的唯一代码。仅包含字母和数字。

limitinteger>= 1

页面上元素数量的限制。

示例: limit=50
offsetinteger>= 0

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

示例: offset=0
curl -i -X GET \
  -u <username>:<password> \
  'https://store.xsolla.com/api/v2/project/44056/admin/code/limit/coupon/external_id/coupon_44056_1?codes%5B%5D=string&limit=50&offset=0'

响应

成功收到代码的优惠券限额。

正文application/json
has_moreboolean

如果存在其他含代码的页面。

itemsArray of objects(Code-limit-promo-code)
promotion_idinteger

促销活动ID。项目内的唯一促销活动标识符。

total_items_countnumber

代码总数。

响应
application/json
{ "has_more": false, "items": [ {}, {} ], "promotion_id": 1, "total_items_count": 2 }

激活优惠券促销活动Server-sideAdmin

请求

激活优惠券促销活动。 默认情况下创建的优惠券促销活动为禁用状态。 激活之前,不能进行兑换。 使用此端点启用和激活优惠券促销活动。

安全
basicAuth
路径
project_idinteger必需

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

示例: 44056
external_idinteger必需

促销活动外部ID。项目内的唯一促销活动标识符。

示例: coupon_44056_1
curl -i -X PUT \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/coupon/coupon_44056_1/activate

响应

优惠券已成功激活。

响应
无内容

获取优惠券码Server-sideAdmin

请求

获取优惠券码。

安全
basicAuth
路径
project_idinteger必需

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

示例: 44056
external_idinteger必需

促销活动外部ID。项目内的唯一促销活动标识符。

示例: coupon_44056_1
查询
limitinteger>= 1

页面上元素数量的限制。

示例: limit=50
offsetinteger>= 0

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

示例: offset=0
curl -i -X GET \
  -u <username>:<password> \
  'https://store.xsolla.com/api/v2/project/44056/admin/coupon/coupon_44056_1/code?limit=50&offset=0'

响应

已成功接收优惠券码列表。

正文application/json
codesArray of objects
total_countnumber

优惠券码总数。

响应
application/json
{ "codes": [ {}, {}, {}, {}, {} ], "total_count": 5 }

促销码

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

操作

特别目录优惠

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

操作

折扣

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

操作

奖励

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

操作

个性化目录

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

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

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

操作
操作
操作
操作
操作
操作
操作
操作
操作
操作
操作