跳转到内容

Shop Builder 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

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

管理

操作

个性化目录

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

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

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

操作

获取目录筛选规则列表Server-sideAdmin

请求

获取应用于用户属性的所有规则。

安全
basicAuth
路径
project_idinteger必需

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

示例: 44056
查询
limitinteger>= 1

页面上元素数量的限制。

示例: limit=50
offsetinteger>= 0

元素编号，从该元素开始生成列表（从0开始数）。

示例: offset=0
is_enabledinteger

通过is_enabled标志筛选元素。

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/zh/api/shop-builder/v2/project/44056/admin/user/attribute/rule?limit=50&offset=0&is_enabled=0'

响应

规则已成功接收。

正文application/json
has_moreboolean

如果存在其他带规则的页面。

itemsArray of objects(user-attribute_personalized-catalog)
total_items_countnumber

规则总数。

响应
application/json
{
  "has_more": true,
  "items": [
    { … }
  ],
  "total_items_count": 20
}

创建目录筛选规则Server-sideAdmin

请求

创建用户属性的规则。

安全
basicAuth
路径
project_idinteger必需

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

示例: 44056
正文application/json
attribute_conditionsArray of type = string (object) or type = number (object) or type = date (object)(personalized-catalog_user-attribute_conditions_model-post)[ 1 .. 100 ] items必需

用户属性验证条件。 根据用户属性是否满足所有指定条件来确定目录商品可用性。

One of:
attribute_conditions[].​attributestring(user-attribute_conditions_properties_attribute)[ 1 .. 255 ] characters^[-_.\d\w]+$必需

用户属性代码。

attribute_conditions[].​can_be_missingboolean(user-attribute_conditions_properties_can_be_missing)

表示即使用户属性中缺少属性仍满足条件。传递true可向不具有此属性的用户显示该项目。具有该属性但值与条件中指定的值不匹配的用户将看不到该商品。传递false则具有该属性但值与条件中指定的值不匹配或缺少该属性的用户将看不到该商品。

attribute_conditions[].​operatorstring(user-attribute_conditions_properties_operator_string)必需

按条件执行的操作类型。用于string属性类型。

枚举 值描述
eq

等于

ne

不等于

attribute_conditions[].​typestring(user-attribute_conditions_properties_type-string)必需

用户属性类型。

值"string"
attribute_conditions[].​valuestring(user-attribute_conditions_properties_value)<= 255 characters必需

与用户属性值进行比较的条件值。类型取决于属性类型。

is_enabledboolean必需

如果已启用规则。

is_satisfied_for_unauthboolean

是否向未经授权的用户显示该商品。如为true，无论目录显示规则如何，该商品都会向未经授权的用户显示。默认为false。

itemsArray of objects[ 1 .. 100 ] items必需
One of:

属性值满足条件的情况下向用户显示的商品。

items[].​item_idnumber必需

物品ID。

namestring[ 1 .. 255 ] characters^\S必需

规则的可读名称。用于在发布商帐户中显示规则。

curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/zh/api/shop-builder/v2/project/44056/admin/user/attribute/rule \
  -H 'Content-Type: application/json' \
  -d '{
    "attribute_conditions": [
      {
        "attribute": "race",
        "can_be_missing": false,
        "operator": "eq",
        "type": "string",
        "value": "ork"
      }
    ],
    "is_enabled": true,
    "is_satisfied_for_unauth": false,
    "items": [
      {
        "item_id": 1
      }
    ],
    "name": "Ork race armor rule"
  }'

响应

规则已成功创建。

正文application/json
rule_idnumber

规则ID。

响应
application/json
{
  "rule_id": 1
}

获取所有目录规则以供在客户端搜索Server-sideAdmin

请求

获取所有目录规则列表以供在客户端搜索。

注意：

仅返回规则ID、名称和is_enabled
安全
basicAuth
路径
project_idinteger必需

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

示例: 44056
curl -i -X GET \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/zh/api/shop-builder/v2/project/44056/admin/user/attribute/rule/all

响应

规则已成功接收。

正文application/json
itemsArray of objects(user-attribute_personalized-catalog_all)
响应
application/json
{
  "items": [
    { … },
    { … }
  ]
}

管理

操作

目录

操作

购物车（客户端侧）

操作

购物车（服务器侧）

操作

支付（客户端）

操作

支付（服务器端）

操作

订单

操作

免费商品

操作

Webhook

操作

预订

操作

商户

操作

目录

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

操作

通用区域

操作

目录

操作

权利

操作

管理

操作

通用

操作

优惠券

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

操作

促销码

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

操作

特别目录优惠

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

操作

折扣

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

操作

奖励

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

操作

管理

操作

目录

操作

虚拟支付

操作

管理

操作

管理

操作

客户端

操作

公会客户端

操作

管理

操作

客户端

操作

管理

操作

客户端

操作

管理

操作

客户端

操作

管理

操作