跳转到内容

Digital Distribution Hub (1.0.0)

概览

Digital Distribution Hub是一个全新的艾克索拉解决方案，旨在通过推送支付(Push payments)技术和电子商务来联结数字与现金支付。

本参考指南合并介绍了用于以下两个艾克索拉产品的API端点：游戏内商店和支付中心。基础URL有两个：

  • https://store.xsolla.com/api ，用于常用、目录、购物车和订单组。
  • https://ps.xsolla.com，用于通知组。

目录组中的API端点不需要授权。

要使用购物车和订单组中的操作，需通过创建用户令牌来生成一个令牌。

注：

本参考展示的是未来可能的API设计，并非已经完全运作的界面。目前只支持尝试目录和通知组端点。如想向我们提供反馈，请发送邮件至techdoc@xsolla.com。
下载 OpenAPI 描述
index.json
index.yaml
语言
服务器
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/zh/api/digital-distribution-hub/

购物车

操作

游戏密钥

操作

虚拟物品和货币

操作

捆绑包

操作

用户令牌

操作

通知

操作

订单

操作

获取订单

请求

检索指定的订单。

安全
AuthForClient
路径
project_idinteger必需

项目ID。

示例: 44056
order_idstring必需

订单ID。

示例: 656
curl -i -X GET \
  https://store.xsolla.com/api/v2/project/44056/distribution_hub/order/656 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

响应

成功的订单请求。

正文application/json
contentobject(Order_inline_response_200_1_content)

订单详细信息。

content.​is_freestring

如果为true，则订单是免费的。

示例: "false"
content.​itemsArray of objects(Order_inline_response_200_1_content_items)

商品清单。

示例: [{"is_free":false,"price":{"amount":"30","amount_without_discount":"30","currency":"USD"},"quantity":1,"sku":"some_sku"}]
content.​items[].​is_freestring

如果为true，则该商品为免费。

示例: "false"
content.​items[].​priceobject(Order_inline_response_200_1_content_price_1)

商品价格。

content.​items[].​price.​amountstring

折扣后的商品价格。

示例: "30"
content.​items[].​price.​amount_without_discountstring

商品价格。

示例: "30"
content.​items[].​price.​currencystring

默认购买货币。符合ISO 4217的三字母代码。

示例: "USD"
content.​items[].​quantityinteger

商品数量。

示例: 1
content.​items[].​skustring

唯一商品ID。 SKU只能包含小写英文字母和数字字符、句点、破折号和下划线。

示例: "some_sku"
content.​priceobject(Order_inline_response_200_1_content_price)

订单价格。

content.​price.​amountstring

订单折扣价。

示例: "30"
content.​price.​amount_without_discountstring

订单价格。

示例: "30"
content.​price.​currencystring

默认购买货币。符合ISO 4217的三字母代码。

示例: "USD"
content.​virtual_priceobject(Order_inline_response_200_1_content_virtual_price)

以虚拟货币表示的订单价格。

content.​virtual_price.​amountstring

订单折扣价。

示例: "100"
content.​virtual_price.​amount_without_discountstring

订单价格。

示例: "150"
content.​virtual_price.​currencystring

订单中使用的虚拟货币SKU。

示例: "test_vc"
order_idinteger

订单ID。

示例: 1
statusstring

订单状态：new/paid/done/canceled。

示例: "paid"
响应
application/json
{
  "content": {
    "is_free": "false",
    "items": [ … ],
    "price": { … }
  },
  "order_id": 1,
  "status": "paid"
}

使用当前购物车中的所有商品创建订单

请求

使用购物车中的所有商品创建订单。创建的订单将获得new订单状态。

安全
AuthForClient
路径
project_idinteger必需

项目ID。

示例: 44056
正文application/json必需

包含订单创建数据的对象。

currencystring(Cart-Payment_settings_currency)必需

首选支付币种。参照ISO 4217标准的三字母货币代码。

geotypenumber必需

艾克索拉侧的分发合作伙伴ID。

示例: 13038
quantityinteger

商品数量。

示例: 1
curl -i -X POST \
  https://store.xsolla.com/api/v2/project/44056/distribution_hub/payment/cart \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "geotype": 13038
  }'

响应

订单已成功创建。

正文application/json
billing_infoobject(Order_inline_response_200_billing_info)

账单信息。

billing_info.​direct_taxArray of objects(Order_inline_response_200_billing_info_direct_tax)
billing_info.​direct_tax[].​amountnumber
示例: 150
billing_info.​direct_tax[].​namestring
示例: "TAX"
billing_info.​direct_tax[].​ratenumber
示例: 10
billing_info.​indirect_taxArray of objects(Order_inline_response_200_billing_info_indirect_tax)
billing_info.​indirect_tax[].​amountnumber
示例: 246.75
billing_info.​indirect_tax[].​namestring
示例: "VAT"
billing_info.​indirect_tax[].​ratenumber
示例: 20
billing_info.​priceobject(Order_inline_response_200_billing_info_price)
billing_info.​price.​amountnumber
示例: 1480.45
billing_info.​price.​currencystring= 3 characters

购买货币。符合ISO 4217的三字母代码。

示例: "USD"
order_idinteger

订单ID。

响应
application/json
{
  "billing_info": {
    "direct_taxes": [ … ],
    "indirect_taxes": [ … ],
    "price": { … }
  },
  "order_id": 641
}

使用指定购物车中的所有商品创建订单

请求

使用指定购物车中的所有商品创建订单。创建的订单将获得new订单状态。

安全
AuthForClient
路径
project_idinteger必需

项目ID。

示例: 44056
cart_idstring必需

购物车ID。

示例: custom_id
正文application/json必需

包含订单创建数据的对象。

currencystring(Cart-Payment_settings_currency)必需

首选支付币种。参照ISO 4217标准的三字母货币代码。

geotypenumber必需

艾克索拉侧的分发合作伙伴ID。

示例: 13038
quantityinteger

商品数量。

示例: 1
curl -i -X POST \
  https://store.xsolla.com/api/v2/project/44056/distribution_hub/payment/cart/custom_id \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "geotype": 13038
  }'

响应

订单已成功创建。

正文application/json
billing_infoobject(Order_inline_response_200_billing_info)

账单信息。

billing_info.​direct_taxArray of objects(Order_inline_response_200_billing_info_direct_tax)
billing_info.​direct_tax[].​amountnumber
示例: 150
billing_info.​direct_tax[].​namestring
示例: "TAX"
billing_info.​direct_tax[].​ratenumber
示例: 10
billing_info.​indirect_taxArray of objects(Order_inline_response_200_billing_info_indirect_tax)
billing_info.​indirect_tax[].​amountnumber
示例: 246.75
billing_info.​indirect_tax[].​namestring
示例: "VAT"
billing_info.​indirect_tax[].​ratenumber
示例: 20
billing_info.​priceobject(Order_inline_response_200_billing_info_price)
billing_info.​price.​amountnumber
示例: 1480.45
billing_info.​price.​currencystring= 3 characters

购买货币。符合ISO 4217的三字母代码。

示例: "USD"
order_idinteger

订单ID。

响应
application/json
{
  "billing_info": {
    "direct_taxes": [ … ],
    "indirect_taxes": [ … ],
    "price": { … }
  },
  "order_id": 641
}