跳转到内容
/
通过ID上传密钥

Catalog API (2.0.0)

Overview

  • Version: 2.0.0
  • Servers: https://store.xsolla.com/api
  • Contact Us by Email
  • Contact URL: https://xsolla.com/
  • Required TLS version: 1.2

Catalog API提供端点，用于管理您的游戏内商店目录并处理购买。使用这些端点配置虚拟物品、虚拟货币、游戏密钥、捆绑包、购物车和支付流程、物品属性，以及从外部来源导入物品。

下载 OpenAPI 描述
index.json
index.yaml
语言
服务器
Mock server
https://xsolla.redocly.app/_mock/zh/api/catalog/
https://store.xsolla.com/api/

管理

操作

目录

操作

虚拟支付

操作

目录

操作

权利

操作

管理

操作

获取密钥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://xsolla.redocly.app/_mock/zh/api/catalog/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://xsolla.redocly.app/_mock/zh/api/catalog/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"
}

获取密钥加载会话信息Server-sideAdmin

请求

获取密钥加载会话信息。

安全
basicAuth
路径
project_idinteger必需

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

示例: 44056
session_idstring必需

会话ID。

默认值 "fc7105b6e8ee01339582970b37697242"
curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/zh/api/catalog/v2/project/44056/admin/items/game/key/upload/session/{session_id}'

响应

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

正文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允许获取任意类型的可售商品或指定商品。

操作

通用区域

操作

管理

操作