跳转到内容

Overview

  • Version: 2.0.0
  • Servers: https://store.xsolla.com/api
  • Contact Us by Email
  • Contact URL: https://xsolla.com/
  • Required TLS version: 1.2

LiveOps API提供用于提升玩家参与度的端点。

下载 OpenAPI 描述
语言
服务器
Mock server
https://xsolla.redocly.app/_mock/zh/api/liveops/
https://store.xsolla.com/api/
操作

优惠券

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

操作

生成优惠券码Server-sideAdmin

请求

生成优惠券码。

安全
basicAuth
路径
project_idinteger必需

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

示例: 44056
external_idinteger必需

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

示例: coupon_44056_1
正文application/json
countinteger(Promotions_coupon-generate-count)[ 1 .. 100000 ]必需
示例: 10
curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/zh/api/liveops/v2/project/44056/admin/coupon/coupon_44056_1/code/generate \
  -H 'Content-Type: application/json' \
  -d '{
    "count": 10
  }'

响应

代码已成功生成。

正文application/json
countinteger(Promotions_coupon-generate-count)[ 1 .. 100000 ]
示例: 10
响应
application/json
{ "count": 10 }

停用优惠券促销活动Server-sideAdmin

请求

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

安全
basicAuth
路径
project_idinteger必需

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

示例: 44056
external_idinteger必需

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

示例: coupon_44056_1
curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/zh/api/liveops/v2/project/44056/admin/coupon/coupon_44056_1/deactivate

响应

优惠券已成功停用。

响应
无内容

获取指定用户的优惠券限制Server-sideAdmin

请求

获取指定用户可以使用优惠券的剩余次数。

用户限制API允许您限制用户可以使用优惠券的次数。要配置用户限制数本身,请前往“管理”部分:

安全
basicAuth
路径
project_idinteger必需

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

示例: 44056
external_idinteger必需

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

示例: coupon_44056_1
查询
user_external_idstring必需

用户外部ID

示例: user_external_id=d342dad2-9d59-11e9-a384-42010aa8003f
curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/zh/api/liveops/v2/project/44056/admin/user/limit/coupon/external_id/coupon_44056_1?user_external_id=d342dad2-9d59-11e9-a384-42010aa8003f'

响应

成功收到用户的优惠券限制。

正文application/json
per_userobject
响应
application/json
{ "per_user": { "available": 9, "total": 10 } }

促销码

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

操作

特别目录优惠

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

操作

折扣

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

操作

奖励

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

操作

个性化目录

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

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

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

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