跳转到内容

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允许获取任意类型的可售商品或指定商品。

操作
操作
操作
操作
操作

通过ID上传密钥Server-sideAdmin

请求

按游戏密钥ID上传密钥。

安全
basicAuth
路径
project_idinteger必需

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

示例: 44056
item_idstring必需

物品ID。

示例: 656
正文multipart/form-data
filestring(binary)必需

包含密钥的文件。

示例: "keys.txt"
region_idinteger

区域ID。

示例: 1
curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/zh/api/shop-builder/v2/project/44056/admin/items/game/key/upload/id/656 \
  -H 'Content-Type: multipart/form-data' \
  -F file=keys.txt \
  -F region_id=1

响应

已成功接收密钥加载会话信息。

正文application/json
count_skippedinteger
示例: 10
count_totalinteger
示例: 100
count_uploadedinteger
示例: 0
session_idstring
示例: "fc7105b6e8ee01339582970b37697242"
statusstring
示例: "processing"
响应
application/json
{ "count_skipped": 10, "count_total": 100, "count_uploaded": 0, "session_id": "fc7105b6e8ee01339582970b37697242", "status": "processing" }

获取密钥加载会话信息Server-sideAdmin

请求

获取密钥加载会话信息。

安全
basicAuth
路径
project_idinteger必需

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

示例: 44056
session_idstring必需

会话ID。

默认值 "fc7105b6e8ee01339582970b37697242"
curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/zh/api/shop-builder/v2/project/44056/admin/items/game/key/upload/session/{session_id}'

响应

已成功接收密钥加载会话信息。

正文application/json
count_skippedinteger
示例: 10
count_totalinteger
示例: 100
count_uploadedinteger
示例: 0
session_idstring
示例: "fc7105b6e8ee01339582970b37697242"
statusstring
示例: "processing"
响应
application/json
{ "count_skipped": 10, "count_total": 100, "count_uploaded": 0, "session_id": "fc7105b6e8ee01339582970b37697242", "status": "processing" }

请求

按游戏密钥SKU上传密钥。

安全
basicAuth
路径
project_idinteger必需

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

示例: 44056
item_skustring必需

商品SKU。

示例: booster_mega_1
正文multipart/form-data必需
filestring(binary)必需

包含密钥的文件。

示例: "keys.txt"
region_idinteger

区域ID。

示例: 1
curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/zh/api/shop-builder/v2/project/44056/admin/items/game/key/upload/sku/booster_mega_1 \
  -H 'Content-Type: multipart/form-data' \
  -F file=keys.txt \
  -F region_id=1

响应

已成功接收密钥加载会话信息。

正文application/json
count_skippedinteger
示例: 10
count_totalinteger
示例: 100
count_uploadedinteger
示例: 0
session_idstring
示例: "fc7105b6e8ee01339582970b37697242"
statusstring
示例: "processing"
响应
application/json
{ "count_skipped": 10, "count_total": 100, "count_uploaded": 0, "session_id": "fc7105b6e8ee01339582970b37697242", "status": "processing" }
操作

优惠券

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

操作

促销码

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

操作

特别目录优惠

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

操作

折扣

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

操作

奖励

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

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