跳转到内容
/
获取Webhook设置信息

Shop Builder 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

Shop Builder API provides a third-party solution for implementing the server side for your store interface. Use the endpoints to manage in-game items, in-game currencies, cart, player inventory, promotions, game library, etc.

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

管理

操作

个性化目录

此API可让您针对用户属性指定规则。如果用户满足具体规则的所有条件，则会显示个性化商品。

有关个性化促销活动的信息，请参阅促销活动部分。

要在购买前传递属性，您可以使用艾克索拉Login API或在使Pay Station API生成令牌时将它们传入user.attributes属性。

操作

管理

操作

目录

操作

购物车（客户端侧）

操作

购物车（服务器侧）

操作

支付（客户端）

操作

支付（服务器端）

操作

订单

操作

免费商品

操作

Webhook

操作

获取Webhook设置信息Server-sideAdmin

请求

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

安全
basicAuth
路径
project_idinteger必需

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

示例: 44056
curl -i -X GET \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/zh/api/shop-builder/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_free、is_bonus和is_bundle_content，这些在版本1（默认）中不存在。

枚举12
示例: 1
curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/zh/api/shop-builder/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允许获取任意类型的可售商品或指定商品。

操作

通用区域

操作

目录

操作

权利

操作

管理

操作

通用

操作

优惠券

此API让您可以管理优惠券。

操作

促销码

此API让您可以管理促销码。

操作

特别目录优惠

此API让您可以管理特别目录优惠活动。

操作

折扣

此API让您可以管理折扣促销活动。

操作

奖励

此API让您可以管理奖励促销活动。

操作

管理

操作

目录

操作

虚拟支付

操作

管理

操作

管理

操作

客户端

操作

公会客户端

操作

管理

操作

客户端

操作

管理

操作

客户端

操作

管理

操作

客户端

操作

管理

操作