跳转到内容
/
设置商品的奖励积分

LiveOps API (2.0.0)

概述

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

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

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

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

API调用

API分为以下组别:

  • Admin — 用于创建、更新、激活和删除营销活动及奖励链配置。通过基本认证方式验证身份，需使用您的商户或项目凭据。
  • Client — 用于检索可用促销活动、获取活跃奖励链、兑换码，以及代表最终用户（已完成身份认证）领取奖励。通过用户JWT进行身份认证。
下载 OpenAPI 描述
index.json
index.yaml
语言
服务器
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属性。

操作

管理

操作

管理

操作

部分更新商品的奖励积分Server-sideAdmin

请求

按照商品SKU来部分更新一个或多个商品的奖励积分数量。用户在购买指定商品后可获得这些奖励积分。

更新奖励积分的原则：

  • 如果某个商品尚无奖励积分，则在amount字段中发送非零值将创建奖励积分。
  • 如果某个商品已有奖励积分，则在amount字段中发送非零值将更新原有值。
  • 如果amount设置为0，则会删除该商品的现有奖励积分。

与PUT方法（设置商品的奖励积分）不同，此PATCH方法不会覆盖项目中所有商品的现有奖励积分，它只会更新指定的商品。

单个请求最多可以更新100个商品。同一请求中不能包含重复的商品SKU。

安全
basicAuth
路径
project_idinteger必需

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

示例: 44056
value_point_skustring必需

奖励积分SKU。

示例: value_point_3
正文application/jsonArray [
amountinteger>= 0必需

奖励积分的数量。

skustring(sku)[ 1 .. 255 ] characters^[a-zA-Z0-9_\-–.]*$必需

唯一商品ID。 SKU只能包含大小写英文字母和数字字符、句点、破折号和下划线。

示例: "booster_mega_1"
]
curl -i -X PATCH \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/items/value_point_3/value_points/rewards \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "amount": 100,
      "sku": "booster_1"
    },
    {
      "amount": 0,
      "sku": "booster_mega"
    }
  ]'

响应

已成功更新商品的奖励积分。

正文
响应
无内容

设置商品的奖励积分Server-sideAdmin

请求

按SKU将奖励积分分配给一件或多件商品。用户购买这些商品后将获得奖励积分。

请注意，此PUT请求将覆盖项目中商品所有先前设置的奖励积分。

为了避免无意中删除奖励积分，请在每个PUT请求中包含所有商品及其各自的奖励积分。

如果只想更新特定商品的奖励积分，同时保留其他商品的奖励积分，则应使用GET请求检索当前的奖励积分集，修改所需商品的奖励积分，然后返回包含特定商品更新后奖励积分的奖励积分集。

安全
basicAuth
路径
project_idinteger必需

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

示例: 44056
value_point_skustring必需

奖励积分SKU。

示例: value_point_3
正文application/jsonArray [
amountinteger必需

奖励积分的数量。

skustring(sku)[ 1 .. 255 ] characters^[a-zA-Z0-9_\-–.]*$必需

唯一商品ID。 SKU只能包含大小写英文字母和数字字符、句点、破折号和下划线。

示例: "booster_mega_1"
]
curl -i -X PUT \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/items/value_point_3/value_points/rewards \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "amount": 100,
      "sku": "com.xsolla.booster_1"
    },
    {
      "amount": 200,
      "sku": "com.xsolla.booster_mega"
    }
  ]'

响应

已成功更新商品的奖励积分。

正文
响应
无内容

获取奖励链列表Server-sideAdmin

请求

获取奖励链列表。

注意：

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

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

示例: 44056
查询
limitinteger>= 1

页面上元素数量的限制。

示例: limit=50
offsetinteger>= 0

元素编号，从该元素开始生成列表（从0开始数）。

示例: offset=0
enabledinteger

通过is_enabled标志筛选元素。

curl -i -X GET \
  -u <username>:<password> \
  'https://store.xsolla.com/api/v3/project/44056/admin/reward_chain?limit=50&offset=0&enabled=0'

响应

已成功接收奖励链列表。

正文application/json
has_moreboolean(Pagination_has-more)

用作指示还有更多页面。

示例: true
itemsArray of admin-get-reward-chain-item-basic-model (object) or admin-get-reward-chain-item-clan-basic-model (object)
响应
application/json
{
  "has_more": true,
  "items": [
    { … },
    { … }
  ]
}

客户端

操作

公会客户端

操作

管理

操作

客户端

操作

管理

操作

客户端

操作

管理

操作

客户端

操作