跳转到内容
/
通过代码获取兑换型促销活动

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/

通用

操作

获取所有促销活动列表Server-sideAdmin

请求

获取项目的促销活动列表。

安全
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/promotion?limit=50&offset=0&enabled=0'

响应

已成功接收促销活动列表。

正文application/json
active_promotions_countinteger(active_promotions_count)

进行中的促销活动的数量。

inactive_promotions_countinteger(inactive_promotions_count)

已停用的促销活动的数量。

promotionsArray of objects(Promotions_200-get-promotion-model)
total_promotions_countinteger(total_promotions_count)

促销活动总数。

响应
application/json
{
  "active_promotions_count": 3,
  "inactive_promotions_count": 2,
  "promotions": [
    { … },
    { … },
    { … },
    { … },
    { … }
  ],
  "total_promotions_count": 5
}

通过代码获取兑换型促销活动Server-sideAdmin

请求

通过促销码或优惠券码获取促销活动。

安全
basicAuth
路径
project_idinteger必需

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

示例: 44056
codestring[ 1 .. 128 ] characters必需

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

示例: WINTER2021
curl -i -X GET \
  -u <username>:<password> \
  https://store.xsolla.com/api/v3/project/44056/admin/promotion/redeemable/code/WINTER2021

响应

成功收到促销活动。

正文application/json
bonusArray of objects or null(Promotions_coupon_bonus)
discountobject or null

仅适用于促销码。

示例: {"discount":{"percent":"10.99"}}
discounted_itemsArray of objects or null

通过促销码打折的商品列表。仅适用于促销码。

external_idstring(Promotions_coupon-external_id)

唯一促销活动ID。 external_id只能包含大小写英文字母和数字字符、句点、破折号和下划线。

默认值 "coupon_external_id"
示例: "coupon_external_id"
is_enabledboolean(Promotions_coupon-is_enabled)
默认值 true
nameobject(Promotions_coupon_name)

促销活动名称。应包含键/值对， 其中键是"^[a-z]{2}-[A-Z]{2}$"格式的区域设置，值是字符串。

默认值 {"de-DE":"Gutscheintitel","en-US":"Coupon title"}
示例: {"de-DE":"Gutscheintitel","en-US":"Coupon title"}
promotion_periodsArray of objects(promotion_periods)

促销活动有效期。若指定了多个时间段，则date_from和date_until均为必需。

redeem_code_limitinteger or null(Promotions_redeem_code_limit)

每个代码的兑换次数。

默认值 10
示例: 10
redeem_total_limitinteger or null(Promotions_coupon-redeem_total_limit)

限制优惠券的总数。

默认值 10
示例: 10
redeem_user_limitinteger or null(Promotions_coupon-redeem_user_limit)

限制单个用户兑换的优惠券总数。

默认值 10
示例: 10
total_limit_stateobject or null(Promotions_coupon_total_limit_state)

每个唯一优惠券码的限制。

响应
application/json
{
  "bonus": [
    { … }
  ],
  "external_id": "coupon_fall_hammer_2",
  "is_enabled": true,
  "name": {
    "en": "This is a Coupon code for Epic Fall Hammer",
    "ru": "Eto kod kupona на Epic Fall Hammer"
  },
  "promotion_periods": [
    { … },
    { … }
  ],
  "redeem_code_limit": null,
  "redeem_total_limit": 99,
  "redeem_user_limit": 1
}

优惠券

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

操作

促销码

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

操作

特别目录优惠

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

操作

折扣

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

操作

奖励

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

操作

个性化目录

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

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

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

操作

管理

操作

管理

操作

客户端

操作

公会客户端

操作

管理

操作

客户端

操作

管理

操作

客户端

操作

管理

操作

客户端

操作