跳转到内容
/
获取用于目录的游戏

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
语言
服务器
Mock server
https://xsolla.redocly.app/_mock/zh/api/digital-distribution-hub/
https://store.xsolla.com/api/

购物车

操作

游戏密钥

操作

获取用于目录的游戏

请求

获取用于目录的游戏。

安全
AuthForClient
路径
project_idinteger必需

项目ID。

示例: 44056
item_skustring必需

商品SKU。

示例: booster_mega_1
查询
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://xsolla.redocly.app/_mock/zh/api/digital-distribution-hub/v2/project/44056/items/game/key/sku/booster_mega_1?locale=en&additional_fields%5B%5D=string&country=US' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

响应

已成功收到游戏。

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

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

默认值 []
descriptionstring

商品描述。

示例: "Game description"
drm_namestring

DRM名称。

示例: "Steam"
drm_skustring

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

示例: "steam"
groupsArray of objects(Catalog_inline_response_200_groups)

商品所属分组。

示例: [{"external_id":"all","name":"All games"},{"external_id":"Xsolla","name":"Xsolla games"}]
has_keysboolean

如果为true，则游戏密钥有供销售的密钥。

示例: true
image_urlstring

图像URL。

示例: "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png"
is_freeboolean

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

示例: false
is_pre_orderboolean

如果为true，则游戏密钥为预订，并且发布日期尚未到来。

示例: true
namestring

商品名称。

示例: "Game name"
priceobject(Catalog_inline_response_200_price)

商品价格。

release_datestring

符合ISO 8601规定格式的游戏发行日期。

示例: "2020-08-11T10:00:00+03:00"
skustring

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

示例: "game_1"
typestring

商品类型：game_key。

示例: "game_key"
virtual_pricesArray of objects(Catalog_inline_response_200_virtual_prices)

虚拟价格。

示例: []
响应
application/json
{
  "attributes": {
    "$ref": "#/components/examples/client-attribute-game-horror/Catalog_value"
  },
  "description": "Game description",
  "drm_name": "Steam",
  "drm_sku": "steam",
  "groups": [
    { … },
    { … }
  ],
  "has_keys": true,
  "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
  "is_free": false,
  "is_pre_order": true,
  "name": "Game name",
  "price": {
    "amount": "30.5",
    "amount_without_discount": "30.5",
    "currency": "USD"
  },
  "release_date": "2020-08-11T10:00:00+03:00",
  "sku": "game_1",
  "type": "game_key",
  "virtual_prices": []
}

获取用于目录的游戏

请求

获取用于目录的游戏。

安全
AuthForClient
路径
project_idinteger必需

项目ID。

示例: 44056
item_skustring必需

商品SKU。

示例: booster_mega_1
查询
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://xsolla.redocly.app/_mock/zh/api/digital-distribution-hub/v2/project/44056/items/game/sku/booster_mega_1?locale=en&additional_fields%5B%5D=string&country=US' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

响应

成功收到游戏。

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

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

注意：这部分响应仅在您发送`additional_fields[]=attributes`查询参数时可用。
默认值 []
descriptionstring

商品描述。

示例: "Game description"
groupsArray of objects(Catalog_inline_response_200_groups)

商品所属分组。

示例: [{"external_id":"all","name":"All games"},{"external_id":"Xsolla","name":"Xsolla games"}]
image_urlstring

图像URL。

示例: "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png"
namestring

商品名称。

示例: "Game name"
skustring

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

示例: "game_1"
typestring

商品类型：virtual_good/virtual_currency/bundle/physical_good/unit。

示例: "unit"
unit_itemsArray of objects(Catalog_inline_response_200_unit_items)
示例: [{"drm_name":"Steam","drm_sku":"steam","has_keys":true,"is_free":false,"is_pre_order":true,"price":{"amount":"30.5","amount_without_discount":"30.5","currency":"USD"},"release_date":"2020-08-11T10:00:00+03:00","sku":"game_key_01","type":"game_key","virtual_prices":[]},{"drm_name":"Origin","drm_sku":"origin","has_keys":false,"is_free":false,"is_pre_order":false,"price":{"amount":"30.5","amount_without_discount":"30.5","currency":"USD"},"sku":"game_key_02","type":"game_key","virtual_prices":[]}]
unit_typestring

单位类型：game。

示例: "game"
响应
application/json
{
  "attributes": {
    "$ref": "#/components/examples/client-attribute-game/Catalog_value"
  },
  "description": "Game description",
  "groups": [
    { … },
    { … }
  ],
  "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
  "name": "Game name",
  "sku": "game_1",
  "type": "unit",
  "unit_items": [
    { … },
    { … }
  ],
  "unit_type": "game"
}

虚拟物品和货币

操作

捆绑包

操作

用户令牌

操作

通知

操作

订单

操作