跳转到内容
/
获取指定的捆绑包

Digital Distribution Hub (1.0.0)

概览

Digital Distribution Hub是一个全新的艾克索拉解决方案，旨在通过推送支付(Push payments)技术和电子商务来联结数字与现金支付。

本参考指南合并介绍了用于以下两个艾克索拉产品的API端点：游戏内商店和支付中心。基础URL有两个：

  • https://store.xsolla.com/api ，用于常用、目录、购物车和订单组。
  • https://ps.xsolla.com，用于通知组。

目录组中的API端点不需要授权。

要使用购物车和订单组中的操作，需通过创建用户令牌来生成一个令牌。

注：

本参考展示的是未来可能的API设计，并非已经完全运作的界面。目前只支持尝试目录和通知组端点。如想向我们提供反馈，请发送邮件至techdoc@xsolla.com。
下载 OpenAPI 描述
index.json
index.yaml
语言
服务器
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/zh/api/digital-distribution-hub/

购物车

操作

游戏密钥

操作

虚拟物品和货币

操作

捆绑包

操作

获取捆绑包列表

请求

获取用于构建目录的捆绑包列表。

注意：所有项目对于可以在响应中获得的商品数量均都限制。默认值和最大值是每个响应50项。
安全
AuthForClient
路径
project_idinteger必需

项目ID。

示例: 44056
查询
limitinteger

页面上元素数量的限制。

示例: limit=50
offsetinteger

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

示例: offset=0
localestring

响应语言。符合ISO 639-1标准的两个小写字母的语言代码。

默认值 "en"
additional_fields[]Array of strings

附加字段列表。如果在请求中发送这些字段，则它们将包含在响应中。可用字段media_list、order、long_description。

countrystring

对于该目录要计算区域价格和限制的国家/地区。符合ISO 3166-1 alpha-2的两个大写字母的国家/地区代码。如果未明确指定国家/地区，则将根据用户的IP地址进行计算。

默认值 "US"
curl -i -X GET \
  'https://store.xsolla.com/api/v2/project/44056/items/bundle?limit=50&offset=0&locale=en&additional_fields%5B%5D=string&country=US' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

响应

捆绑包列表已成功接收。

正文application/json
itemsArray of objects(Catalog_client_bundle)
items[].​attributesArray of objects(Catalog_client-attributes-common)

与商品对应的属性及其值的列表。可用于目录筛选。

默认值 []
items[].​attributes[].​external_idstring(Catalog_admin-attribute-external_id)[ 1 .. 255 ] characters^[a-zA-Z0-9-_]+$

唯一属性ID。 external_id只能包含小写英文字母和数字字符、破折号和下划线。

示例: "attribute_1"
items[].​attributes[].​namestring

属性名称。

示例: "Genre"
items[].​attributes[].​valuesArray of objects
items[].​attributes[].​values[].​external_idstring(Catalog_value-external_id)[ 1 .. 255 ] characters^[-_.\d\w]+$

属性的唯一值ID。 external_id只能包含小写英文字母和数字字符、破折号和下划线。

示例: "attribute_value"
items[].​attributes[].​values[].​valuestring

属性值。

示例: "Strategy"
items[].​bundle_typestring(Catalog_bundle_type)

捆绑包类型。此情况下始终为standart。

示例: "standart"
items[].​contentArray of objects(Catalog_client_content)

捆绑包套餐内容。

示例: [{"attributes":[],"description":"Big Rocket - short description.","groups":[],"image_url":"https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png","is_free":false,"name":"Big Rocket","price":{"amount":10.99,"amount_without_discount":10.99,"currency":"USD"},"quantity":100,"sku":"big_rocket","type":"virtual_currency"}]
items[].​content[].​descriptionstring

商品描述。

示例: "Big Rocket - description"
items[].​content[].​image_urlstring

图像URL。

示例: "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png"
items[].​content[].​namestring

商品名称。

示例: "Big Rocket"
items[].​content[].​priceobject or null

商品价格。

items[].​content[].​price.​amountstring

折扣后的商品价格。

示例: "100.99"
items[].​content[].​price.​amount_without_discountstring

商品价格。

示例: "100.99"
items[].​content[].​price.​currencystring

默认购买货币。符合ISO 4217的三字母代码。

示例: "USD"
items[].​content[].​quantityinteger

套餐中的商品数量。

示例: 250
items[].​content[].​skustring

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

示例: "big_rocket"
items[].​content[].​typestring

商品类型：virtual_good/virtual_currency/bundle。

示例: "virtual_currency"
items[].​content[].​virtual_pricesArray of objects

虚拟价格。

items[].​content[].​virtual_prices[].​amountinteger

以虚拟货币表示的折扣后商品价格。

示例: 100
items[].​content[].​virtual_prices[].​amount_without_discountinteger

商品价格。

示例: 200
items[].​content[].​virtual_prices[].​descriptionstring

虚拟货币说明。

示例: "Big Rocket - description"
items[].​content[].​virtual_prices[].​image_urlstring

虚拟货币图像。

示例: "http://image.png"
items[].​content[].​virtual_prices[].​is_defaultboolean

价格是否为商品的默认价格。

示例: true
items[].​content[].​virtual_prices[].​namestring

虚拟货币名称。

示例: "SHOTGUN FOR TRUE RAIDERS"
items[].​content[].​virtual_prices[].​skustring

虚拟货币商品SKU。

示例: "vc_test"
items[].​content[].​virtual_prices[].​typestring

虚拟货币类型。

示例: "virtual_currency"
items[].​descriptionstring or null(Catalog_client_description)

商品描述。

示例: "Big Rocket - description."
items[].​groupsArray of objects(Catalog_groups_response)

商品所属分组。

默认值 []
示例: [{"external_id":"horror","name":{"en":"Horror"}}]
items[].​groups[].​external_idstring
示例: "horror"
items[].​groups[].​nameobject
示例: {"en":"Horror"}
items[].​image_urlstring or null(Catalog_image_url)

图像URL。

示例: "https://image.example.com"
items[].​is_freestring(Catalog_is_free)

始终为false。

默认值 "false"
示例: "false"
items[].​namestring(Catalog_client_name)

商品名称。

示例: "Big Rocket"
items[].​priceobject or null(Catalog_price)

商品价格。

items[].​price.​amountstring(Catalog_amount)^\d*\.?\d*$必需

折扣后的商品价格。

示例: "100.99"
items[].​price.​amount_without_discountstring(Catalog_amount_without_discount)^\d*\.?\d*$必需

商品价格。

示例: "100.99"
items[].​price.​currencystring(Catalog_currency)必需

购买货币。符合ISO 4217的三字母代码。

示例: "USD"
items[].​skustring(Catalog_sku)

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

示例: "bundle_1"
items[].​total_content_priceobject or null(Catalog_total_content_price)

捆绑包内容价格总和。

items[].​total_content_price.​amountstring

折扣后的捆绑包内容价格总和。

示例: "100.99"
items[].​total_content_price.​amount_without_discountstring

捆绑包内容价格总和。

示例: "100.99"
items[].​total_content_price.​currencystring(Catalog_currency)

购买货币。符合ISO 4217的三字母代码。

示例: "USD"
items[].​typestring(Catalog_type)

商品类型。

示例: "bundle"
items[].​virtual_pricesArray of objects(Catalog_virtual_prices)

虚拟价格。

items[].​virtual_prices[].​amountinteger

以虚拟货币表示的折扣后商品价格。

示例: 100
items[].​virtual_prices[].​amount_without_discountinteger

以虚拟货币表示的商品价格。

示例: 200
items[].​virtual_prices[].​descriptionstring or null

虚拟货币说明。

示例: "Most popular gold"
items[].​virtual_prices[].​image_urlstring or null

虚拟货币图像。

示例: "http://image.png"
items[].​virtual_prices[].​is_defaultboolean

价格是否为商品的默认价格。

示例: true
items[].​virtual_prices[].​namestring

虚拟货币名称。

示例: "Gold"
items[].​virtual_prices[].​skustring

虚拟货币商品SKU。

示例: "gold"
items[].​virtual_prices[].​typestring

虚拟货币类型。

示例: "virtual_currency"
响应
application/json
{
  "items": [
    { … }
  ]
}

获取指定的捆绑包

请求

获取指定的捆绑包。

安全
AuthForClient
路径
project_idinteger必需

项目ID。

示例: 44056
skustring必需

捆绑包SKU。

示例: kg_1
curl -i -X GET \
  https://store.xsolla.com/api/v2/project/44056/items/bundle/sku/kg_1 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

响应

指定的捆绑包已成功接收。

正文application/json
attributesArray of objects(Catalog_client-attributes-common)

与商品对应的属性及其值的列表。可用于目录筛选。

默认值 []
attributes[].​external_idstring(Catalog_admin-attribute-external_id)[ 1 .. 255 ] characters^[a-zA-Z0-9-_]+$

唯一属性ID。 external_id只能包含小写英文字母和数字字符、破折号和下划线。

示例: "attribute_1"
attributes[].​namestring

属性名称。

示例: "Genre"
attributes[].​valuesArray of objects
attributes[].​values[].​external_idstring(Catalog_value-external_id)[ 1 .. 255 ] characters^[-_.\d\w]+$

属性的唯一值ID。 external_id只能包含小写英文字母和数字字符、破折号和下划线。

示例: "attribute_value"
attributes[].​values[].​valuestring

属性值。

示例: "Strategy"
bundle_typestring(Catalog_bundle_type)

捆绑包类型。此情况下始终为standart。

示例: "standart"
contentArray of objects(Catalog_client_content)

捆绑包套餐内容。

示例: [{"attributes":[],"description":"Big Rocket - short description.","groups":[],"image_url":"https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png","is_free":false,"name":"Big Rocket","price":{"amount":10.99,"amount_without_discount":10.99,"currency":"USD"},"quantity":100,"sku":"big_rocket","type":"virtual_currency"}]
content[].​descriptionstring

商品描述。

示例: "Big Rocket - description"
content[].​image_urlstring

图像URL。

示例: "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png"
content[].​namestring

商品名称。

示例: "Big Rocket"
content[].​priceobject or null

商品价格。

content[].​price.​amountstring

折扣后的商品价格。

示例: "100.99"
content[].​price.​amount_without_discountstring

商品价格。

示例: "100.99"
content[].​price.​currencystring

默认购买货币。符合ISO 4217的三字母代码。

示例: "USD"
content[].​quantityinteger

套餐中的商品数量。

示例: 250
content[].​skustring

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

示例: "big_rocket"
content[].​typestring

商品类型：virtual_good/virtual_currency/bundle。

示例: "virtual_currency"
content[].​virtual_pricesArray of objects

虚拟价格。

content[].​virtual_prices[].​amountinteger

以虚拟货币表示的折扣后商品价格。

示例: 100
content[].​virtual_prices[].​amount_without_discountinteger

商品价格。

示例: 200
content[].​virtual_prices[].​descriptionstring

虚拟货币说明。

示例: "Big Rocket - description"
content[].​virtual_prices[].​image_urlstring

虚拟货币图像。

示例: "http://image.png"
content[].​virtual_prices[].​is_defaultboolean

价格是否为商品的默认价格。

示例: true
content[].​virtual_prices[].​namestring

虚拟货币名称。

示例: "SHOTGUN FOR TRUE RAIDERS"
content[].​virtual_prices[].​skustring

虚拟货币商品SKU。

示例: "vc_test"
content[].​virtual_prices[].​typestring

虚拟货币类型。

示例: "virtual_currency"
descriptionstring or null(Catalog_client_description)

商品描述。

示例: "Big Rocket - description."
groupsArray of objects(Catalog_groups_response)

商品所属分组。

默认值 []
示例: [{"external_id":"horror","name":{"en":"Horror"}}]
groups[].​external_idstring
示例: "horror"
groups[].​nameobject
示例: {"en":"Horror"}
image_urlstring or null(Catalog_image_url)

图像URL。

示例: "https://image.example.com"
is_freestring(Catalog_is_free)

始终为false。

默认值 "false"
示例: "false"
namestring(Catalog_client_name)

商品名称。

示例: "Big Rocket"
priceobject or null(Catalog_price)

商品价格。

price.​amountstring(Catalog_amount)^\d*\.?\d*$必需

折扣后的商品价格。

示例: "100.99"
price.​amount_without_discountstring(Catalog_amount_without_discount)^\d*\.?\d*$必需

商品价格。

示例: "100.99"
price.​currencystring(Catalog_currency)必需

购买货币。符合ISO 4217的三字母代码。

示例: "USD"
skustring(Catalog_sku)

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

示例: "bundle_1"
total_content_priceobject or null(Catalog_total_content_price)

捆绑包内容价格总和。

total_content_price.​amountstring

折扣后的捆绑包内容价格总和。

示例: "100.99"
total_content_price.​amount_without_discountstring

捆绑包内容价格总和。

示例: "100.99"
total_content_price.​currencystring(Catalog_currency)

购买货币。符合ISO 4217的三字母代码。

示例: "USD"
typestring(Catalog_type)

商品类型。

示例: "bundle"
virtual_pricesArray of objects(Catalog_virtual_prices)

虚拟价格。

virtual_prices[].​amountinteger

以虚拟货币表示的折扣后商品价格。

示例: 100
virtual_prices[].​amount_without_discountinteger

以虚拟货币表示的商品价格。

示例: 200
virtual_prices[].​descriptionstring or null

虚拟货币说明。

示例: "Most popular gold"
virtual_prices[].​image_urlstring or null

虚拟货币图像。

示例: "http://image.png"
virtual_prices[].​is_defaultboolean

价格是否为商品的默认价格。

示例: true
virtual_prices[].​namestring

虚拟货币名称。

示例: "Gold"
virtual_prices[].​skustring

虚拟货币商品SKU。

示例: "gold"
virtual_prices[].​typestring

虚拟货币类型。

示例: "virtual_currency"
响应
application/json
{
  "attributes": [],
  "bundle_type": "standard",
  "content": [
    { … }
  ],
  "description": "pricePoint_44056_1.",
  "groups": [],
  "is_free": false,
  "media_list": [],
  "name": "kg_10.00_bundle",
  "order": 999,
  "price": {
    "amount": 9.99,
    "amount_without_discount": 9.99,
    "currency": "USD"
  },
  "sku": "kg_1",
  "total_content_amount": {
    "amount": 10.99,
    "amount_without_discount": 10.99,
    "currency": "USD"
  },
  "type": "bundle",
  "virtual_prices": []
}

用户令牌

操作

通知

操作

订单

操作