跳转到内容
/
获取密钥

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调用

API分为以下组别：

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

管理

操作

目录

操作

虚拟支付

操作

目录

操作

权利

操作

管理

操作

通过ID获取密钥Server-sideAdmin

请求

通过游戏密钥ID获取指定数量的密钥。

安全
basicAuth
路径
project_idinteger必需

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

示例: 44056
item_idstring必需

物品ID。

示例: 656
查询
user_emailstring必需

用户电子邮件。

示例: user_email=email@email.com
quantityinteger必需

密钥数量。

示例: quantity=100
reasonstring必需

收到密钥的原因。

示例: reason=Very important
region_idinteger

区域ID。

默认值 1
curl -i -X GET \
  -u <username>:<password> \
  'https://store.xsolla.com/api/v2/project/44056/admin/items/game/key/request/id/656?user_email=email%40email.com&quantity=100&reason=Very+important&region_id=1'

响应

密钥已成功接收。

正文text/plain
string
响应
text/plain
PIN-CODE-ALL PIN-CODE-ALL-3

获取密钥Server-sideAdmin

请求

通过游戏密钥SKU获取指定数量的密钥。

安全
basicAuth
路径
project_idinteger必需

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

示例: 44056
item_skustring必需

商品SKU。

示例: booster_mega_1
查询
user_emailstring必需

用户电子邮件。

示例: user_email=email@email.com
quantityinteger必需

密钥数量。

示例: quantity=100
reasonstring必需

收到密钥的原因。

示例: reason=Very important
region_idinteger

区域ID。

默认值 1
curl -i -X GET \
  -u <username>:<password> \
  'https://store.xsolla.com/api/v2/project/44056/admin/items/game/key/request/sku/booster_mega_1?user_email=email%40email.com&quantity=100&reason=Very+important&region_id=1'

响应

密钥已成功接收。

正文text/plain
string
响应
text/plain
PIN-CODE-ALL PIN-CODE-ALL-3

通过ID上传密钥Server-sideAdmin

请求

按游戏密钥ID上传密钥。

安全
basicAuth
路径
project_idinteger必需

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

示例: 44056
item_idstring必需

物品ID。

示例: 656
正文multipart/form-data
filestring(binary)必需

包含密钥的文件。

示例: "keys.txt"
region_idinteger

区域ID。

示例: 1
curl -i -X POST \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/items/game/key/upload/id/656 \
  -H 'Content-Type: multipart/form-data' \
  -F file=keys.txt \
  -F region_id=1

响应

已成功接收密钥加载会话信息。

正文application/json
count_skippedinteger
示例: 10
count_totalinteger
示例: 100
count_uploadedinteger
示例: 0
session_idstring
示例: "fc7105b6e8ee01339582970b37697242"
statusstring
示例: "processing"
响应
application/json
{
  "count_skipped": 10,
  "count_total": 100,
  "count_uploaded": 0,
  "session_id": "fc7105b6e8ee01339582970b37697242",
  "status": "processing"
}

管理

操作

目录

操作

购物车（客户端侧）

操作

购物车（服务器侧）

操作

支付（客户端）

操作

支付（服务器端）

操作

订单

操作

免费商品

操作

管理

操作

管理

操作

Webhook

操作

预订

操作

商户

操作

目录

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

操作

通用区域

操作

管理

操作