跳转到内容

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让您可以管理优惠券。

操作

促销码

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

操作

特别目录优惠

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

操作

折扣

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

操作

奖励

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

操作

个性化目录

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

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

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

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

获取当前用户的每日奖励Client-side

请求

客户端端点。获取当前用户的每日奖励。

注意

此方法返回分页的商品列表。最大值和默认值为每个响应50项。如要从列表中获取更多项,请使用`limit`和`offset`参数并获取更多页。例如,当使用`limit = 25`和`offset = 100`调用方法时,响应将从整体列表中的第101项开始返回25项。
安全
XsollaLoginUserJWT
路径
project_idinteger必需

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

示例: 44056
查询
limitinteger>= 1

页面上元素数量的限制。

示例: limit=50
offsetinteger>= 0

元素编号,从该元素开始生成列表(从0开始数)。

示例: offset=0
curl -i -X GET \
  'https://xsolla.redocly.app/_mock/zh/api/liveops/v2/project/44056/user/daily_chain?limit=50&offset=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

响应

用户每日奖励检索成功。

正文application/json
has_moreboolean

用作指示还有更多页面。

示例: true
itemsArray of any(client-daily-chain-model)
total_items_countinteger

每日奖励总数。

示例: 3
响应
application/json
{ "has_more": false, "items": [ {}, {}, {}, {} ], "total_items_count": 3 }

通过ID获取当前用户的每日奖励Client-side

请求

客户端端点。通过ID获取当前用户的每日奖励。

安全
XsollaLoginUserJWT
路径
project_idinteger必需

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

示例: 44056
daily_chain_idinteger必需

每日奖励ID。

示例: 101
curl -i -X GET \
  https://xsolla.redocly.app/_mock/zh/api/liveops/v2/project/44056/user/daily_chain/101 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

响应

用户每日奖励检索成功。

正文application/json
date_startstring(date-time)(calendar_hard_date_start)

每日奖励开始日期。

示例: "2020-04-15T18:16:00+05:00"
is_recurrentboolean(calendar_hard_is_recurrent)

每日奖励是否循环。如果为true,每日奖励将在结束日期后自动重置。下个周期的start_dateend_date基于每日奖励步骤总数和首次start_date的时间设定自动计算。

默认值 false
示例: true
typestring

决定用户可领取奖励时间的每日奖励类型。

枚举 值描述
calendar_hard

每24小时解锁下一步骤奖励。下一步骤奖励可用后,之前未领取的奖励将永久失效。

rolling_skippable

基于date_start每24小时解锁下一步骤奖励。奖励按顺序解锁:必须领取当前奖励才能解锁下一个。用户跳过数天后可从上次进度继续;错过的天数不会累积多个奖励。

rolling_unskippable

基于date_start每24小时解锁下一步骤奖励。奖励按顺序解锁:必须领取当前奖励才能解锁下一个。若用户跳过一天,进度将重置,需从第一步重新开始。

鉴别器
date_endstring or null(date-time)(daily_chain_date_end)

每日奖励结束日期。可以为null。类型设置为calendar_hard时将根据添加的步骤数量自动设置此日期,因此可以将其保留为null

示例: "2020-04-15T18:16:00+05:00"
descriptionstring or null

每日奖励描述。

示例: "Major weekly quest"
idinteger

每日奖励ID。

示例: 9
namestring

每日奖励名称。

示例: "Weekly quest"
orderinteger(order)

定义排列顺序。

示例: 1
stepsArray of objects(client-daily-chain-step-model)
响应
application/json
{ "date_end": "2025-04-03T18:16:00+05:00", "date_start": "2025-04-01T18:16:00+05:00", "description": "Active daily reward description", "id": 101, "name": "Active daily reward", "order": 1, "steps": [ {}, {}, {}, {} ], "type": "calendar_hard" }

领取每日奖励步骤Client-side

请求

客户端端点。从每日奖励中领取当前用户的步骤奖励。所有步骤只能按顺序领取。错过步骤的奖励无法通过虚拟或真实货币购买或通过观看广告获得

安全
XsollaLoginUserJWT
路径
project_idinteger必需

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

示例: 44056
daily_chain_idinteger必需

每日奖励ID。

示例: 101
step_numberinteger必需

每日奖励步骤编号。

示例: 1
curl -i -X POST \
  https://xsolla.redocly.app/_mock/zh/api/liveops/v2/project/44056/user/daily_chain/101/step/number/1/claim \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

响应

成功领取当前用户每日奖励步骤的奖励。

响应
无内容
操作
操作
操作
操作