跳转到内容

LiveOps API (2.0.0)

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 描述
index.json
index.yaml
语言
服务器
Mock server
https://xsolla.redocly.app/_mock/zh/api/liveops/
https://store.xsolla.com/api/

通用

操作

优惠券

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

操作

促销码

此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://xsolla.redocly.app/_mock/zh/api/liveops/v2/project/44056/admin/code/limit/promocode/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://xsolla.redocly.app/_mock/zh/api/liveops/v2/project/44056/admin/promocode/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://xsolla.redocly.app/_mock/zh/api/liveops/v2/project/44056/admin/promocode/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可让您针对用户属性指定规则。如果用户满足具体规则的所有条件，则会显示个性化商品。

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

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

操作

管理

操作

管理

操作

客户端

操作

公会客户端

操作

管理

操作

客户端

操作

管理

操作

客户端

操作

管理

操作

客户端

操作