跳转到内容
/
获取虚拟物品列表

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项。要逐页获取更多数据，请使用limit和offset字段。
安全
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/virtual_currency/package?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_inline_response_200_7_items)
示例: [{"attributes":[],"bundle_type":"virtual_currency_package","content":[{"description":"Big Rocket - short description","image_url":"https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png","inventory_options":{"consumable":{"usages_count":1}},"name":"Big Rocket","quantity":100,"sku":"big_rocket","type":"virtual_currency"}],"description":"VC Short Package Description","groups":[],"image_url":"http://vc_package_image.png","is_free":false,"name":"VC Name first package","price":{"amount":"2.0000","amount_without_discount":"2.0000","currency":"USD"},"sku":"vc_package_1","type":"bundle","virtual_prices":[]},{"attributes":[],"bundle_type":"virtual_currency_package","content":[{"description":"description","image_url":"http://image.png","inventory_options":{"consumable":{"usages_count":1}},"name":"SHOTGUN FOR TRUE RAIDERS","quantity":200,"sku":"shotgun_raider","type":"virtual_currency"}],"description":"VC Short Package Description","groups":[],"image_url":"http://vc_package_image.png","is_free":false,"name":"VC Name third package","price":{"amount":"4.0000","amount_without_discount":"4.0000","currency":"USD"},"sku":"vc_package_3","type":"bundle","virtual_prices":[]}]
items[].​attributesArray of objects(Catalog_client-attributes)

游戏对应的属性及属性值列表。

注意：这部分响应仅在您发送`additional_fields[]=attributes`查询参数时可用。
默认值 []
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

捆绑包类型：standard/virtual_currency_package。

示例: "virtual_currency_package"
items[].​contentArray of objects(Catalog_inline_response_200_7_content)

虚拟货币套餐内容。

示例: [{"description":"Big Rocket - short description","image_url":"https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png","inventory_options":{"consumable":{"usages_count":1}},"name":"Big Rocket","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[].​inventory_optionsobject(Catalog_inline_response_200_7_inventory_options)

定义物品库商品选项。

items[].​content[].​inventory_options.​consumableobject or null(Catalog_inline_response_200_5_inventory_options_consumable)

如果为消耗品，则定义消耗品属性；如果为非消耗品，则为null。

items[].​content[].​inventory_options.​consumable.​usages_countinteger or null

如果为消耗品，则为总剩余使用次数；如果为非消耗品，则为null。

示例: 1
items[].​content[].​inventory_options.​expiration_periodobject or null(Catalog_inline_response_200_7_inventory_options_expiration_period)

如果为到期商品，则定义到期属性；如果为非到期商品，则为null。

items[].​content[].​inventory_options.​expiration_period.​typestring

定义商品的到期类型。

枚举"minute""hour""day""week""month""year"
示例: "day"
items[].​content[].​inventory_options.​expiration_period.​valueinteger

定义有效期的值。

示例: 1
items[].​content[].​namestring

商品名称。

示例: "Big Rocket"
items[].​content[].​quantityinteger

套餐中的虚拟货币数量。

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

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

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

商品类型：virtual_good/virtual_currency/bundle。

示例: "virtual_currency"
items[].​descriptionstring

商品描述。

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

商品所属分组。

示例: [{"external_id":"accessory","name":"Accessory"}]
items[].​groups[].​external_idstring
示例: "accessory"
items[].​groups[].​namestring
示例: "Accessory"
items[].​image_urlstring

图像URL。

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

如果为true，则该商品为免费。

示例: "false"
items[].​namestring

商品名称。

示例: "Big Rocket"
items[].​priceobject(Catalog_inline_response_200_5_price)

商品价格。

items[].​price.​amountstring

折扣后的商品价格。

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

商品价格。

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

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

示例: "USD"
items[].​skustring

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

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

商品类型：virtual_good/virtual_currency/bundle。

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

虚拟价格。

items[].​virtual_prices[].​amountinteger

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

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

商品价格。

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

虚拟货币说明。

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

虚拟货币图像。

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

商品价格是否为默认。

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

虚拟货币名称。

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

虚拟货币商品SKU。

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

虚拟货币类型。

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

获取虚拟物品列表

请求

获取用于构建目录的虚拟物品列表。

注意：所有项目对于可以在响应中获得的商品数量均都限制。默认值和最大值是每个响应50项。要逐页获取更多数据，请使用limit和offset字段。
安全
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/virtual_items?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_inline_response_200_5_items)
示例: [{"attributes":[{"external_id":"stack_size","name":"Stack size","values":[{"external_id":"size_e3364991f92e751689a68b96598a5a5a84010b85","value":"5"}]}],"description":"Big Rocket - description","groups":[{"external_id":"accessory","name":"Accessory"}],"image_url":"https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png","inventory_options":{"consumable":{"usages_count":1},"expiration_period":{"type":"day","value":1}},"is_free":false,"name":"Big Rocket","price":{"amount":"100.99","amount_without_discount":"100.99","currency":"USD"},"sku":"big_rocket","type":"virtual_good","virtual_item_type":"non_renewing_subscription","virtual_prices":[{"amount":100,"amount_without_discount":100,"description":"description","image_url":"http://image.png","is_default":true,"name":"SHOTGUN FOR TRUE RAIDERS","sku":"vc_test","type":"virtual_currency"}]},{"attributes":[{"external_id":"stack_size","name":"Stack size","values":[{"external_id":"size_e3364991f92e751689a68b96598a5a5a84010b85","value":"5"}]},{"external_id":"rating","name":"Rating","values":[{"external_id":"rating_e3364991f92e751689a68b96598a5a5a84010b85","value":"3.9"}]}],"description":"description","groups":[{"external_id":"hair","name":"Hair"}],"image_url":"http://image.png","inventory_options":{"consumable":{"usages_count":1},"expiration_period":{"type":"day","value":1}},"is_free":false,"name":"SHOTGUN FOR TRUE RAIDERS","price":{"amount":"101.0","amount_without_discount":"101.0","currency":"USD"},"sku":"shotgun_raider","type":"virtual_good","virtual_item_type":"non_renewing_subscription","virtual_prices":[{"amount":100,"amount_without_discount":100,"description":"description","image_url":"http://image.png","is_default":true,"name":"SHOTGUN FOR TRUE RAIDERS","sku":"vc_test","type":"virtual_currency"},{"amount":200,"amount_without_discount":200,"description":"description","image_url":"http://image.png","is_default":false,"name":"SHOTGUN FOR TRUE RAIDERS","sku":"vc_test_2","type":"virtual_currency"}]},{"attributes":[],"description":"description","groups":[],"image_url":"http://image.png","inventory_options":{"consumable":{"usages_count":1},"expiration_period":{"type":"day","value":1}},"is_free":true,"name":"SHOTGUN FOR TRUE RAIDERS","sku":"shotgun_raider_2","type":"virtual_good","virtual_item_type":"non_renewing_subscription","virtual_prices":[]}]
items[].​attributesArray of objects(Catalog_client-attributes)

游戏对应的属性及属性值列表。

注意：这部分响应仅在您发送`additional_fields[]=attributes`查询参数时可用。
默认值 []
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[].​descriptionstring

商品描述。

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

商品所属分组。

示例: [{"external_id":"accessory","name":"Accessory"}]
items[].​groups[].​external_idstring
示例: "accessory"
items[].​groups[].​namestring
示例: "Accessory"
items[].​image_urlstring

图像URL。

示例: "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png"
items[].​inventory_optionsobject(Catalog_inline_response_200_5_inventory_options)

定义物品库商品选项。

items[].​inventory_options.​consumableobject or null(Catalog_inline_response_200_5_inventory_options_consumable)

如果为消耗品，则定义消耗品属性；如果为非消耗品，则为null。

items[].​inventory_options.​consumable.​usages_countinteger or null

如果为消耗品，则为总剩余使用次数；如果为非消耗品，则为null。

示例: 1
items[].​inventory_options.​expiration_periodobject or null(Catalog_inline_response_200_5_inventory_options_expiration_period)

如果为到期商品，则定义到期属性；如果为非到期商品，则为null。

items[].​inventory_options.​expiration_period.​typestring

定义商品到期类型。

枚举"minute""hour""day""week""month""year"
示例: "day"
items[].​inventory_options.​expiration_period.​valueinteger

定义有效期的值。

示例: 1
items[].​is_freeboolean

如果为true，则该商品为免费。

示例: false
items[].​namestring

商品名称。

示例: "Big Rocket"
items[].​priceobject(Catalog_inline_response_200_5_price)

商品价格。

items[].​price.​amountstring

折扣后的商品价格。

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

商品价格。

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

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

示例: "USD"
items[].​skustring

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

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

商品类型：virtual_good/virtual_currency/bundle。

示例: "virtual_good"
items[].​virtual_item_typestring

虚拟物品的类型。

枚举"consumable""non_consumable""non_renewing_subscription"
示例: "non-consumable"
items[].​virtual_pricesArray of objects(Catalog_inline_response_200_virtual_prices)

虚拟价格。

items[].​virtual_prices[].​amountinteger

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

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

商品价格。

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

虚拟货币说明。

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

虚拟货币图像。

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

商品价格是否为默认。

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

虚拟货币名称。

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

虚拟货币商品SKU。

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

虚拟货币类型。

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

按指定组获取商品列表

请求

从指定组获取商品列表以构建目录。

注意：所有项目对于可以在响应中获得的商品数量均都限制。默认值和最大值是每个响应50项。要逐页获取更多数据，请使用limit和offset字段。
安全
AuthForClient
路径
project_idinteger必需

项目ID。

示例: 44056
external_idstring必需

组外部ID。

默认值 "all"
查询
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/virtual_items/group/{external_id}?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_inline_response_200_8_items)
示例: [{"attributes":[{"external_id":"stack_size","name":"Stack size","values":[{"value":"5"}]}],"description":"Big Rocket - description","groups":[{"external_id":"accessory","name":"Accessory"}],"image_url":"https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png","inventory_options":{"consumable":{"usages_count":1},"expiration_period":{"type":"day","value":1}},"is_free":false,"name":"Big Rocket","price":{"amount":"100.99","amount_without_discount":"100.99","currency":"USD"},"sku":"big_rocket","type":"virtual_good","virtual_item_type":"non_renewing_subscription","virtual_prices":[{"amount":100,"amount_without_discount":100,"description":"description","image_url":"http://image.png","is_default":true,"name":"SHOTGUN FOR TRUE RAIDERS","sku":"vc_test","type":"virtual_currency"}]},{"attributes":[{"external_id":"stack_size","name":"Stack size","values":[{"value":"5"}]},{"external_id":"rating","name":"Rating","values":[{"value":"3.9"}]},{"external_id":"genre","name":"Genre","values":[{"value":"Strategy"},{"value":"Tactical"},"Turn-based"]}],"description":"description","groups":[{"external_id":"accessory","name":"Accessory"}],"image_url":"http://image.png","inventory_options":{"consumable":{"usages_count":1},"expiration_period":{"type":"day","value":1}},"is_free":false,"name":"SHOTGUN FOR TRUE RAIDERS","price":{"amount":"101.0","amount_without_discount":"101.0","currency":"USD"},"sku":"shotgun_raider","type":"virtual_good","virtual_item_type":"non_renewing_subscription","virtual_prices":[{"amount":100,"amount_without_discount":100,"description":"description","image_url":"http://image.png","is_default":true,"name":"SHOTGUN FOR TRUE RAIDERS","sku":"vc_test","type":"virtual_currency"},{"amount":200,"amount_without_discount":200,"description":"description","image_url":"http://image.png","is_default":false,"name":"SHOTGUN FOR TRUE RAIDERS","sku":"vc_test_2","type":"virtual_currency"}]}]
items[].​attributesArray of objects(Catalog_client-attributes)

游戏对应的属性及属性值列表。

注意：这部分响应仅在您发送`additional_fields[]=attributes`查询参数时可用。
默认值 []
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[].​descriptionstring

商品描述。

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

商品所属分组。

示例: [{"external_id":"accessory","name":"Accessory"}]
items[].​groups[].​external_idstring
示例: "accessory"
items[].​groups[].​namestring
示例: "Accessory"
items[].​image_urlstring

图像URL。

示例: "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png"
items[].​inventory_optionsobject(Catalog_inline_response_200_7_inventory_options)

定义物品库商品选项。

items[].​inventory_options.​consumableobject or null(Catalog_inline_response_200_5_inventory_options_consumable)

如果为消耗品，则定义消耗品属性；如果为非消耗品，则为null。

items[].​inventory_options.​consumable.​usages_countinteger or null

如果为消耗品，则为总剩余使用次数；如果为非消耗品，则为null。

示例: 1
items[].​inventory_options.​expiration_periodobject or null(Catalog_inline_response_200_7_inventory_options_expiration_period)

如果为到期商品，则定义到期属性；如果为非到期商品，则为null。

items[].​inventory_options.​expiration_period.​typestring

定义商品的到期类型。

枚举"minute""hour""day""week""month""year"
示例: "day"
items[].​inventory_options.​expiration_period.​valueinteger

定义有效期的值。

示例: 1
items[].​is_freestring

如果为true，则该商品为免费。

示例: "false"
items[].​namestring

商品名称。

示例: "Big Rocket"
items[].​priceobject(Catalog_inline_response_200_5_price)

商品价格。

items[].​price.​amountstring

折扣后的商品价格。

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

商品价格。

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

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

示例: "USD"
items[].​skustring

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

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

商品类型：consumable/expiration/permanent/lootboxes/physical。

示例: "virtual_good"
items[].​virtual_item_typestring

虚拟物品的类型。

枚举"consumable""non_consumable""non_renewing_subscription"
示例: "non_consumable"
items[].​virtual_pricesArray of objects(Catalog_inline_response_200_8_virtual_prices)

虚拟价格。

items[].​virtual_prices[].​amountinteger

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

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

商品价格。

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

虚拟货币说明。

示例: "Big Rocket - description"
items[].​virtual_prices[].​image_urlstring
示例: "http://image.png"
items[].​virtual_prices[].​is_defaultboolean

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

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

虚拟货币名称。

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

虚拟货币商品SKU。

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

虚拟货币类型。

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

捆绑包

操作

用户令牌

操作

通知

操作

订单

操作