Catalog API (2.0.0)
- 版本: 2.0.0
- 服务器:
https://store.xsolla.com/api - 通过邮件联系我们
- 联系URL: https://xsolla.com/
- 必需的TLS版本: 1.2
商品目录API支持在艾克索拉侧配置游戏内商品目录,并在您的商店中向用户展示目录内容。
通过该API可管理以下目录实体:
- 虚拟物品 — 游戏内物品,例如武器、皮肤、增益道具。
- 虚拟货币 — 用于购买虚拟商品的虚拟货币。
- 虚拟货币套餐 — 预定义的虚拟货币捆绑包。
- 捆绑包 — 虚拟物品、货币或游戏激活码的组合套餐,以单个SKU形式出售。
- 游戏密钥 — 适用于Steam等平台或其他DRM提供商分发的游戏和DLC激活码。
- 组 — 用于在目录中组织和排序商品的逻辑分组。
API分为以下组别:
Admin — 用于创建、更新、删除和配置目录商品及分组的调用。通过基本认证方式验证身份,需使用您的商户或项目凭据。不适用于商店前端调用。Catalog — 用于检索商品并构建面向最终用户的自定义商店前端。专为高负载场景设计。支持可选的用户JWT授权,可返回个性化数据,例如用户特定限制和当前进行中的促销活动。
下载 OpenAPI 描述
语言
服务器
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/zh/api/catalog/
查询
正文application/json用户玩游戏的发布平台:xsolla(默认)、playstation_network、xbox_live、pc_standalone、nintendo_shop、google_play、app_store_ios、android_standalone、ios_standalone、android_other、ios_other、pc_other。
默认值 "xsolla"
枚举"playstation_network""xbox_live""xsolla""pc_standalone""nintendo_shop""google_play""app_store_ios""android_standalone""ios_standalone""android_other"
自定义参数的形式是一组有效的JSON键值对。
您可以通过此字段传入补充参数来配置反欺诈筛选条件。 请参阅支付中心文档。
示例: {"custom_parameters":{"bool_param":true,"int_param":100,"null_param":null,"string_param":"example"}}
- https://store.xsolla.com/api/v2/project/{project_id}/payment/item/{item_sku}/virtual/{virtual_currency_sku}
- Mock serverhttps://xsolla.redocly.app/_mock/zh/api/catalog/v2/project/{project_id}/payment/item/{item_sku}/virtual/{virtual_currency_sku}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://store.xsolla.com/api/v2/project/44056/payment/item/booster_mega_1/virtual/crystal?platform=playstation_network' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"custom_parameters": {
"array_param": [
{
"object1": {
"param": "https://xsolla.com"
},
"property": {
"int_property": 112,
"string_property": "xsolla"
}
},
{
"object2": {
"param": "https://developers.xsolla.com/zh"
},
"property": {
"int_property": 112,
"string_property": "email@example.com"
}
}
],
"bool_param": true,
"int_param": 100,
"null_param": null,
"object_param": {
"key": "value"
}
}
}'