跳转到内容

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

Shop Builder API provides a third-party solution for implementing the server side for your store interface. Use the endpoints to manage in-game items, in-game currencies, cart, player inventory, promotions, game library, etc.

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

个性化目录

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

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

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

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

目录

本API允许获取任意类型的可售商品或指定商品。

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

优惠券

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

操作

促销码

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

操作

特别目录优惠

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

操作

折扣

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

操作

奖励

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

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

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

请求

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

注意:

所有项目对于可以在响应中获得的商品数量均都限制。默认值和最大值是每个响应50项。要逐页获取更多数据,请使用limitoffset字段。
安全
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/shop-builder/v2/project/44056/user/reward_chain?limit=50&offset=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

响应

成功获取用户的奖励链。

正文application/json
has_moreboolean

用作指示还有更多页面。

示例: true
itemsArray of objects(client-reward-chain-item-model)
total_items_countinteger

系统中奖励链的总数。

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

获取当前用户的奖励积分余额Client-side

请求

客户端端点。获取当前用户的奖励积分余额。

安全
XsollaLoginUserJWT
路径
project_idinteger必需

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

示例: 44056
reward_chain_idinteger必需

奖励链ID。

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

响应

已成功获取用户的奖励积分余额。

正文application/json
amountinteger

奖励积分数量。

descriptionstring or null(value-point-description)

奖励积分描述。

image_urlstring(Common_admin-image_url)

图像URL。

示例: "https://image.example.com"
is_clanboolean(is_clan)

该奖励积分是否用于公会奖励链。

示例: true
long_descriptionstring or null(value-point-long-description)

奖励积分详细描述。

namestring(value-point-name)

奖励积分名称。

skustring(value-point-sku)

唯一奖励积分ID。

响应
application/json
{ "amount": 80, "description": "Value points for clan reward system.", "image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png", "is_clan": true, "long_description": "Value points given to clans to get new rewards in a reward chain.", "name": "Clan Reward VP 1", "sku": "com.xsolla.clan_value_point_1" }

请求

客户端端点。从奖励链中领取当前用户的步骤奖励。

安全
XsollaLoginUserJWT
路径
project_idinteger必需

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

示例: 44056
reward_chain_idinteger必需

奖励链ID。

示例: 101
step_idinteger必需

奖励链步骤ID。

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

响应

成功从奖励链中领取当前用户的步骤奖励。

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