跳转到内容

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 描述
语言
服务器
Mock server
https://xsolla.redocly.app/_mock/zh/api/catalog/
https://store.xsolla.com/api/
操作
操作
操作
操作
操作
操作
操作
操作
操作
操作
操作
操作
操作
操作
操作
操作
操作

获取Webhook设置信息Server-sideAdmin

请求

获取商店中的Webhook设置信息。 要了解详细信息,请参阅Webhook文档

安全
basicAuth
路径
project_idinteger必需

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

示例: 44056
curl -i -X GET \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/zh/api/catalog/v2/project/44056/admin/webhook

响应

已成功收到Webhook设置信息。

正文application/json
is_enabledboolean
示例: true
secretstring
示例: "my_secret"
urlstring
示例: "http://site.ru/webhook"
响应
application/json
{ "is_enabled": true, "secret": "my_secret", "url": "http://site.ru/webhook" }

更新Webhook设置信息Server-sideAdmin

请求

更新商店中的Webhook设置信息。 要了解详细信息,请参阅Webhook文档

安全
basicAuth
路径
project_idinteger必需

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

示例: 44056
正文application/json必需

Webhook设置信息。

is_enabledboolean必需

游戏服务 Webhook是否已启用。

对于游戏服务 Webhook,此API调用中指定的设置优先于发布商帐户的项目设置 > Webhooks部分中配置的设置。

示例: true
secretstring必需

用于游戏服务 Webhook签名的项目密钥。

对于游戏服务,此API调用中指定的密钥优先于发布者帐户的项目设置 > Webhooks 部分中生成的密钥。

示例: "my_secret_key"
urlstring必需

您的服务器的URL,用于接收游戏服务 Webhook。该URL必须可公开访问并使用HTTPS协议,例如https://example.com。您还可以指定Webhook测试工具提供的任意URL。

对于游戏服务 Webhook,此API调用中指定的设置优先于发布商帐户的项目设置 > Webhooks部分中配置的设置。

示例: "http://site.ru/webhook"
versioninteger

Webhook版本。在版本2中, 商品数组包含参数is_freeis_bonusis_bundle_content,这些在版本1(默认)中不存在。

枚举12
示例: 1
curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/zh/api/catalog/v2/project/44056/admin/webhook \
  -H 'Content-Type: application/json' \
  -d '{
    "is_enabled": true,
    "secret": "my_secret_key",
    "url": "http://site.ru/webhook",
    "version": 1
  }'

响应

已成功更新Webhook设置信息。

响应
无内容
操作
操作

目录

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

操作
操作
操作