跳转到内容
/
使用指定商品创建订单

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/

管理

操作

目录

操作

虚拟支付

操作

目录

操作

权利

操作

管理

操作

管理

操作

目录

操作

购物车（客户端侧）

操作

购物车（服务器侧）

操作

支付（客户端）

操作

使用特定购物车中的所有商品创建订单Client-side

请求

用于客户端到服务器的集成。使用指定购物车中的所有商品创建订单并为其生成支付令牌。创建的订单得到new订单状态。

客户端IP用于确定用户所在的国家/地区，然后用于为订单应用相应的货币和可用的支付方式。

要在新窗口中打开支付UI，请使用以下链接：https://secure.xsolla.com/paystation4/?token={token} ，其中{token}是收到的令牌。

如要进行测试，请使用以下URL：https://sandbox-secure.xsolla.com/paystation4/?token={token}。

注：

由于此方法使用IP来确定用户所在的国家/地区并为订单选择货币，因此必须从客户端而不是从服务器端使用此方法。从服务器端使用此方法可能会导致货币判断错误并影响支付中心中可用的支付方式。
安全
AuthForCart
路径
project_idinteger必需

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

示例: 44056
cart_idstring必需

购物车ID。

示例: custom_id
正文application/json
currencystring

订单价格货币。每笔订单的三个字母的货币代码ISO 4217。请查看文档以获取有关Xsolla 支持的货币。

custom_parametersobject[ 1 .. 200 ] properties

项目特定参数。

localestring

响应语言。

sandboxboolean

在沙盒模式下创建订单。该选项适用于公司用户列表中指定的那些用户。

默认值 false
settingsobject

为用户配置支付流程和支付UI的设置。

curl -i -X POST \
  https://store.xsolla.com/api/v2/project/44056/payment/cart/custom_id \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "custom_parameters": {
      "character_id": "ingameUsername"
    },
    "sandbox": true,
    "settings": {
      "ui": {
        "desktop": {
          "header": {
            "close_button": false,
            "is_visible": true,
            "type": "normal",
            "visible_logo": true,
            "visible_name": true,
            "visible_purchase": true
          }
        },
        "theme": "63295a9a2e47fab76f7708e1"
      }
    }
  }'

响应

订单已成功创建。

正文application/json
order_idinteger

订单ID。

tokenstring

支付令牌。

响应
application/json
{
  "order_id": 641,
  "token": "f4puMEFFDZcx9nv5HoNHIkPe9qghvBQo"
}

使用指定商品创建订单Client-side

请求

用于客户端到服务器的集成。使用指定商品创建订单并为其生成支付令牌。创建的订单得到new订单状态。

客户端IP用于确定用户所在的国家/地区，然后用于为订单应用相应的货币和可用的支付方式。

要在新窗口中打开支付UI，请使用以下链接：https://secure.xsolla.com/paystation4/?token={token} ，其中{token}是收到的令牌。

如要进行测试，请使用以下URL：https://sandbox-secure.xsolla.com/paystation4/?token={token}。

注：

由于此方法使用IP来确定用户所在的国家/地区并为订单选择货币，因此必须从客户端而不是从服务器端使用此方法。从服务器端使用此方法可能会导致货币判断错误并影响支付中心中可用的支付方式。
安全
XsollaLoginUserJWT
路径
project_idinteger必需

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

示例: 44056
item_skustring必需

商品SKU。

示例: booster_mega_1
正文application/json
currencystring

订单价格货币。每笔订单的三个字母的货币代码ISO 4217。请查看文档以获取有关Xsolla 支持的货币。

custom_parametersobject[ 1 .. 200 ] properties

项目特定参数。

localestring

响应语言。

promo_codestring

随支付兑换促销码活动代码。

quantityinteger>= 1

商品数量。

默认值 1
sandboxboolean

在沙盒模式下创建订单。该选项适用于公司用户列表中指定的那些用户。

默认值 false
settingsobject

为用户配置支付流程和支付UI的设置。

curl -i -X POST \
  https://store.xsolla.com/api/v2/project/44056/payment/item/booster_mega_1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "custom_parameters": {
      "character_id": "ingameUsername"
    },
    "promo_code": "discount_code",
    "quantity": 5,
    "sandbox": true,
    "settings": {
      "ui": {
        "desktop": {
          "header": {
            "close_button": false,
            "is_visible": true,
            "type": "normal",
            "visible_logo": true,
            "visible_name": true,
            "visible_purchase": true
          }
        },
        "theme": "63295a9a2e47fab76f7708e1"
      }
    }
  }'

响应

订单已成功创建。

正文application/json
order_idinteger

订单ID。

tokenstring

支付令牌。

响应
application/json
{
  "order_id": 641,
  "token": "f4puMEFFDZcx9nv5HoNHIkPe9qghvBQo"
}

支付（服务器端）

操作

订单

操作

免费商品

操作

管理

操作

管理

操作

Webhook

操作

预订

操作

商户

操作

目录

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

操作

通用区域

操作

管理

操作