跳转到内容

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/deprecated/inventory/
https://store.xsolla.com/api/

客户端

操作

管理

操作

按购买项向用户发放商品Server-sideAdmin

请求

按购买项将指定商品添加到指定的用户物品库中。

注意：

一次只能处理50个操作。超出此限制的操作将被忽略。
安全
basicAuth
路径
project_idinteger必需

项目ID。

默认值 44056
正文application/json必需Array [
commentstring[ 1 .. 255 ] characters

操作说明。例如：“每月挑战奖励”。

默认值 "Monthly challenge rewards"
custom_parametersobject(Player-Inventory_custom_parameters)[ 1 .. 200 ] properties

项目特定参数。

示例: {"array_param":[{"user_device_info":{"engine_version":"Unity 2020.2.0b5","os":"windows"},"user_public_id":{"nickname":"player1"}},{"user_device_info":{"engine_version":"UE 4.25","os":"mac"},"user_public_id":{"nickname":"player1"}}],"bool_param":true,"int_param":100,"null_param":null,"object_param":{"key":"value"}}
itemsArray of objectsnon-empty必需
items[].​quantitynumber必需

需要发放的此类商品数。

默认值 1
items[].​skustring必需

商品类标识符。SKU只能包含小写英文字母、数字字符、句点、破折号和下划线。

默认值 "booster_mega_1"
platformstring

用户玩游戏的发布平台。

默认值 "xsolla"
枚举"playstation_network""xbox_live""xsolla""pc_standalone""nintendo_shop""google_play""app_store_ios""android_standalone""ios_standalone""android_other"
purchaseobject必需
purchase.​amountstring必需

扣除任何减项前的购买金额。

默认值 "2.99"
purchase.​currencystring必需

符合ISO 4217格式的购买货币。

默认值 "USD"
purchase.​external_purchase_datestring必需

符合ISO 8601格式的购买日期。

默认值 "2020-01-01T05:00:00+05:00"
purchase.​external_purchase_idstring必需

来自购买平台的购买发票标识符。

默认值 "10-534-35"
userobject必需
user.​idstring

平台上的唯一用户标识符。

默认值 "d342dad2-9d59-11e9-a384-42010aa8003f"
]
curl -i -X POST \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/zh/api/deprecated/inventory/v2/project/{project_id}/inventory/purchase' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "purchase": {
        "amount": "3.5",
        "comment": "xsolla",
        "currency": "USD",
        "custom_parameters": [
          {
            "user_device_info": {
              "engine_version": "Unity 2020.2.0b5",
              "os": "windows"
            },
            "user_public_id": {
              "nickname": "player1"
            }
          },
          {
            "comment": "xsolla",
            "custom_parameters": {
              "content_creator_rewards": [
                {
                  "content_creator": {
                    "id": "cc1"
                  },
                  "reward": {
                    "amount": "10.00",
                    "currency": "USD"
                  }
                },
                {
                  "content_creator": {
                    "id": "cc2"
                  },
                  "reward": {
                    "amount": "15.00",
                    "currency": "RUB"
                  }
                }
              ]
            },
            "items": [
              {
                "quantity": 5,
                "sku": "com.xsolla.panda_sdk3"
              },
              {
                "quantity": 3,
                "sku": "com.xsolla.panda_sdk2"
              }
            ],
            "platform": "xsolla",
            "purchase": {
              "amount": "3.5",
              "currency": "USD",
              "external_purchase_date": "2020-01-01T00:00:00+05:00",
              "external_purchase_id": "1000001"
            },
            "user": {
              "id": "83857636-65b4-11e8-9ccb-42010a8a001c"
            }
          }
        ],
        "external_purchase_date": "2020-01-01T00:00:00+05:00",
        "external_purchase_id": "1000000",
        "items": [
          {
            "quantity": 5,
            "sku": "com.xsolla.panda_sdk1"
          },
          {
            "quantity": 3,
            "sku": "com.xsolla.panda_sdk2"
          }
        ],
        "platform": "xsolla",
        "user": {
          "id": "672c91cd-65db-4b6e-ad68-6e93b21249d8"
        }
      }
    }
  ]'

响应

用户购买成功。

正文application/json
countinteger
示例: 10
operationsArray of objects
响应
application/json
{
  "count": 2,
  "operations": [
    { … },
    { … }
  ]
}

撤回物品库商品Server-sideAdmin

请求

撤销对多个用户的商品访问权限。

注意：

一次只能处理50个操作。超出此限制的操作将被忽略。
安全
basicAuth
路径
project_idinteger必需

项目ID。

默认值 44056
正文application/json必需Array [
commentstring[ 1 .. 255 ] characters

操作说明。例如：“商品已转移给另一个玩家”。

默认值 "Item was transferred to another player"
itemsArray of objectsnon-empty必需
items[].​quantityinteger>= 1必需

需要撤销的此类商品数。

默认值 1
items[].​skustringnon-empty必需

唯一商品ID。 SKU只能包含大小写英文字母和数字字符、句点、破折号和下划线。

默认值 "booster_mega_1"
platformstring

用户玩游戏的发布平台。

默认值 "xsolla"
枚举"playstation_network""xbox_live""xsolla""pc_standalone""nintendo_shop""google_play""app_store_ios""android_standalone""ios_standalone""android_other"
示例: "xsolla"
userobject必需
user.​idstring

平台上的唯一用户标识符。

默认值 "d342dad2-9d59-11e9-a384-42010aa8003f"
]
curl -i -X POST \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/zh/api/deprecated/inventory/v2/project/{project_id}/inventory/revoke' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "comment": "Item was transferred to another player",
      "items": [
        {
          "quantity": 1,
          "sku": "booster_mega_1"
        }
      ],
      "platform": "xsolla",
      "user": {
        "id": "d342dad2-9d59-11e9-a384-42010aa8003f"
      }
    }
  ]'

响应

用户商品撤回成功。

正文application/json
countinteger

成功撤回其商品的用户数量。

示例: 10
operationsArray of objects

操作说明。

响应
application/json
{
  "count": 2,
  "operations": [
    { … },
    { … }
  ]
}

向用户发放商品Server-sideAdmin

请求

将指定商品添加到指定的用户物品库中。

注意：

一次只能处理50个操作。超出此限制的操作将被忽略。
安全
basicAuth
路径
project_idinteger必需

项目ID。

默认值 44056
正文application/json必需Array [
commentstring[ 1 .. 255 ] characters

操作说明。例如：“每月挑战奖励”。

默认值 "Monthly challenge rewards"
itemsArray of objectsnon-empty必需
items[].​quantitynumber必需

需要发放的此类商品数。

默认值 1
items[].​skustring必需

商品类标识符。SKU只能包含小写英文字母、数字字符、句点、破折号和下划线。

默认值 "booster_mega_1"
platformstring

用户玩游戏的发布平台。

默认值 "xsolla"
枚举"playstation_network""xbox_live""xsolla""pc_standalone""nintendo_shop""google_play""app_store_ios""android_standalone""ios_standalone""android_other"
userobject必需
user.​idstring

平台上的唯一用户标识符。

默认值 "d342dad2-9d59-11e9-a384-42010aa8003f"
]
curl -i -X POST \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/zh/api/deprecated/inventory/v2/project/{project_id}/inventory/reward' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "comment": "Monthly challenge rewards",
      "items": [
        {
          "quantity": 1,
          "sku": "booster_mega_1"
        }
      ],
      "platform": "playstation_network",
      "user": {
        "id": "d342dad2-9d59-11e9-a384-42010aa8003f"
      }
    }
  ]'

响应

用户奖励成功。

正文application/json
countinteger
示例: 10
operationsArray of objects
响应
application/json
{
  "count": 2,
  "operations": [
    { … },
    { … }
  ]
}

将商品设置给用户Server-sideAdmin

请求

将指定商品设置到指定物品库。注意，新数据将替换旧数据。

注意：

一次只能处理50个操作。超出此限制的操作将被忽略。
安全
basicAuth
路径
project_idinteger必需

项目ID。

默认值 44056
正文application/json必需Array [
commentstring[ 1 .. 255 ] characters

操作说明。例如：“每月物品库同步”。

默认值 "Monthly inventory syncing"
itemsArray of objectsnon-empty必需
items[].​quantitynumber必需

需要发放的此类商品数。

默认值 1
items[].​skustring必需

商品类标识符。SKU只能包含小写英文字母、数字字符、句点、破折号和下划线。

默认值 "booster_mega_1"
platformstring

用户玩游戏的发布平台。

默认值 "xsolla"
枚举"playstation_network""xbox_live""xsolla""pc_standalone""nintendo_shop""google_play""app_store_ios""android_standalone""ios_standalone""android_other"
userobject必需
user.​idstring

平台上的唯一用户标识符。

默认值 "d342dad2-9d59-11e9-a384-42010aa8003f"
]
curl -i -X POST \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/zh/api/deprecated/inventory/v2/project/{project_id}/inventory/set' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "comment": "Monthly inventory syncing",
      "items": [
        {
          "quantity": 1,
          "sku": "booster_mega_1"
        }
      ],
      "platform": "playstation_network",
      "user": {
        "id": "d342dad2-9d59-11e9-a384-42010aa8003f"
      }
    }
  ]'

响应

响应成功。

正文application/json
countinteger
示例: 10
operationsArray of objects
响应
application/json
{
  "count": 2,
  "operations": [
    { … },
    { … }
  ]
}

跨平台物品库

操作