コンテンツへスキップ

Digital Distribution Hub (1.0.0)

概要

Digital Distribution Hubは、プッシュペイメント技術やEコマースを介して、デジタルとキャッシュベースの決済を結びつけることを目的とした、エクソラの新しいソリューションです。

この参照は、以下の2つエクソラ製品のAPIエンドポイントを組み合わせたものです：ゲーム内ストアと決済ステーション。2つのベース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/ja/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ごとの3文字のコード。

例: "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ごとの3文字のコード。

例: "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 42173文字通貨コード。

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ごとの3文字のコード。

例: "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 42173文字通貨コード。

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ごとの3文字のコード。

例: "USD"
order_idinteger

注文ID。

レスポンス
application/json
{
  "billing_info": {
    "direct_taxes": [ … ],
    "indirect_taxes": [ … ],
    "price": { … }
  },
  "order_id": 641
}