跳转到内容
/
创建追加销售

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列表。

安全
XsollaLoginUserJWT
路径
project_idinteger必需

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

示例: 44056
curl -i -X GET \
  https://store.xsolla.com/api/v2/project/44056/admin/items/upsell \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

响应

用于项目中追加销售的配置详细信息和商品列表。

正文application/jsonArray [
is_enabledboolean

项目是否启用了追加销售。

示例: true
itemsArray of objects

项目中追加销售包含的商品SKU列表。

示例: [{"item_id":1,"name":{"de":"Name des Artikels","en":"Item's name"},"sku":"com.xsolla.booster_mega_1","type":"virtual_good"}]
typestring

追加销售的类型。

枚举"fixed_list""most_sellable""only_promotions"
示例: "fixed_list"
]
响应
application/json
[
  {
    "is_enabled": true,
    "items": [ … ],
    "type": "fixed_list"
  }
]

创建追加销售Server-sideAdmin

请求

为项目创建追加销售。

安全
XsollaLoginUserJWT
路径
project_idinteger必需

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

示例: 44056
正文application/json
One of:

追加销售类型。

is_enabledboolean(is_enabled)必需
示例: true
itemsArray of strings必需

商品SKU数组。

默认值 null
示例: ["game_sku"]
typestring必需
值"fixed_list"
示例: true
curl -i -X POST \
  https://store.xsolla.com/api/v2/project/44056/admin/items/upsell \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "is_enabled": true,
    "items": [
      "game_sku_1",
      "game_sku_2",
      "game_sku_3"
    ],
    "type": "fixed_list"
  }'

响应

已为该项目创建了追加销售。

响应
无内容

更新追加销售Server-sideAdmin

请求

更新项目的追加销售。

安全
XsollaLoginUserJWT
路径
project_idinteger必需

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

示例: 44056
正文application/json
One of:

追加销售类型。

is_enabledboolean(is_enabled)必需
示例: true
itemsArray of strings必需

商品SKU数组。

默认值 null
示例: ["game_sku"]
typestring必需
值"fixed_list"
示例: true
curl -i -X PUT \
  https://store.xsolla.com/api/v2/project/44056/admin/items/upsell \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "is_enabled": true,
    "items": [
      "game_sku_1",
      "game_sku_2",
      "game_sku_3"
    ],
    "type": "fixed_list"
  }'

响应

该项目的追加销售已更新。

响应
无内容

客户端

操作