跳转到内容

概述

  • 版本: 2.0.0
  • 服务器https://store.xsolla.com/api
  • 通过邮件联系我们
  • 联系URL: https://xsolla.com/
  • 必需的TLS版本: 1.2

商品目录API支持在艾克索拉侧配置游戏内商品目录,并在您的商店中向用户展示目录内容。

通过该API可管理以下目录实体:

  • 虚拟物品 — 游戏内物品,例如武器、皮肤、增益道具。
  • 虚拟货币 — 用于购买虚拟商品的虚拟货币。
  • 虚拟货币套餐 — 预定义的虚拟货币捆绑包。
  • 捆绑包 — 虚拟物品、货币或游戏激活码的组合套餐,以单个SKU形式出售。
  • 游戏密钥 — 适用于Steam等平台或其他DRM提供商分发的游戏和DLC激活码。
  • — 用于在目录中组织和排序商品的逻辑分组。

API调用

API分为以下组别:

  • Admin — 用于创建、更新、删除和配置目录商品及分组的调用。通过基本认证方式验证身份,需使用您的商户或项目凭据。不适用于商店前端调用。
  • Catalog — 用于检索商品并构建面向最终用户的自定义商店前端。专为高负载场景设计。支持可选的用户JWT授权,可返回个性化数据,例如用户特定限制和当前进行中的促销活动。
下载 OpenAPI 描述
语言
服务器
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/zh/api/catalog/
操作
操作
操作
操作
操作
操作
操作
操作
操作
操作
操作
操作
操作
操作
操作
操作
操作
操作
操作

目录

本API允许获取任意类型的可售商品或指定商品。

操作
操作
操作

删除属性值Server-sideAdmin

请求

删除属性值。

注意

删除属性值后,该属性与商品之间的所有关联关系将被移除。如需更改商品的属性值,请使用更新属性值API调用,而不是删除该值再创建新值。
安全
basicAuth
路径
project_idinteger必需

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

示例: 44056
value_external_idstring^[-_\.\d\w]+$必需

属性值外部ID。

示例: value_id
external_idstring必需

属性外部ID。

示例: attribute_id
curl -i -X DELETE \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/attribute/attribute_id/value/value_id

响应

已成功删除属性值。

响应
无内容

更新属性值Server-sideAdmin

请求

更新属性值。

安全
basicAuth
路径
project_idinteger必需

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

示例: 44056
value_external_idstring^[-_\.\d\w]+$必需

属性值外部ID。

示例: value_id
external_idstring必需

属性外部ID。

示例: attribute_id
正文application/json
external_idstring(value-external_id)[ 1 .. 255 ] characters^[-_.\d\w]+$必需

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

示例: "attribute_value"
valueobject(value-name)必需

包含本地化值名称的对象。编码按照ISO 3166-1的规定。

默认值 {"de":"Strategie","en":"Strategy"}
示例: {"de":"Strategie","en":"Strategy"}
value.​property name*string附加属性
curl -i -X PUT \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/attribute/attribute_id/value/value_id \
  -H 'Content-Type: application/json' \
  -d '{
    "external_id": "weapon_class_sword_value",
    "value": {
      "de": "Schwert",
      "en": "Sword"
    }
  }'

响应

属性值已成功更新。

响应
无内容