コンテンツへスキップ

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
curl -i -X GET \
  https://store.xsolla.com/api/v2/project/44056/items/groups \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

レスポンス

グループリストが正常に受信されました。

ボディapplication/json
groupsArray of objects(Catalog_inline_response_200_9_groups)
例: [{"children":[{"children":[{"children":[],"description":"Accessory","external_id":"accessory","level":2,"name":"Accessory","order":1,"parent_external_id":"background"}],"description":"Background description","external_id":"background","level":1,"name":"Background","order":1,"parent_external_id":"hair"}],"description":"Hair description","external_id":"hair","level":0,"name":"Hair","order":1},{"children":[],"description":"Super description","external_id":"group_external_id","level":0,"name":"Super","order":1}]
groups[].​childrenArray of objects(Catalog_inline_response_200_9_children_1)

子グループ。

例: [{"children":[{"children":[],"description":"Accessory","external_id":"accessory","level":2,"name":"Accessory","order":1,"parent_external_id":"background"}],"description":"Background description","external_id":"background","level":1,"name":"Background","order":1,"parent_external_id":"hair"}]
groups[].​children[].​childrenArray of objects(Catalog_inline_response_200_9_children)

子グループ。

例: [{"children":[],"description":"Accessory","external_id":"accessory","level":2,"name":"Accessory","order":1,"parent_external_id":"background"}]
groups[].​children[].​children[].​childrenArray of strings

子グループ。

例: []
groups[].​children[].​children[].​descriptionstring

グループの説明。

例: "Accessory"
groups[].​children[].​children[].​external_idstring

外部グループID。

例: "accessory"
groups[].​children[].​children[].​image_urlstring

画像のURL。

groups[].​children[].​children[].​levelinteger

グループのネスティングレベル。

例: 2
groups[].​children[].​children[].​namestring

グループ名。

例: "Accessory"
groups[].​children[].​children[].​orderinteger

配置順序を定義します。

例: 1
groups[].​children[].​children[].​parent_external_idstring

親外部グループID

例: "background"
groups[].​children[].​descriptionstring

グループの説明。

例: "Background description"
groups[].​children[].​external_idstring

外部グループID。

例: "background"
groups[].​children[].​image_urlstring

グループ画像のURL。

groups[].​children[].​levelinteger

グループのネスティングレベル。

例: 1
groups[].​children[].​namestring

グループ名。

例: "Background"
groups[].​children[].​orderinteger

配置順序を定義します。

例: 1
groups[].​children[].​parent_external_idstring

親外部グループID

例: "hair"
groups[].​descriptionstring

グループの説明。

例: "Hair description"
groups[].​external_idstring

外部グループID。

例: "hair"
groups[].​image_urlstring

画像のURL。

groups[].​levelinteger

グループのネスティングレベル。

例: 0
groups[].​namestring

グループ名。

例: "Hair"
groups[].​orderinteger

配置順序を定義します。

例: 1
groups[].​parent_external_idstring

親外部グループID

レスポンス
application/json
{
  "groups": [
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … }
  ]
}

仮想通貨リストを取得する

リクエスト

カタログを作成するための仮想通貨リストを取得します。

注意すべてのプロジェクトには、応答で取得できるアイテムの数に制限があります。デフォルトおよび最大値は応答あたり50アイテムです。ページごとにより多くのデータを取得するには、制限フィールドとオフセットフィールドを使用します。
セキュリティ
AuthForClient
パス
project_idinteger必須

プロジェクトID。

例: 44056
クエリ
limitinteger

ページにある要素数の制限。

例: limit=50
offsetinteger

リストが生成される要素の番号（0からカウントされる）。

例: offset=0
localestring

応答言語。ISO639-1に準拠した2文字の小文字の言語コード。

デフォルト "en"
additional_fields[]Array of strings

追加フィールドのリスト。これらのフィールドは、リクエストで送信した場合、応答に含まれます。利用可能なフィールドmedia_list、order、long_descriptionです。

countrystring

カタログの地域別価格と制限を計算するための国。ISO 3166-1 alpha-2に準拠した2文字の大文字の国コードです。国を明示的に指定しない場合は、ユーザーのIPアドレスに基づいて計算されます。

デフォルト "US"
curl -i -X GET \
  'https://store.xsolla.com/api/v2/project/44056/items/virtual_currency?limit=50&offset=0&locale=en&additional_fields%5B%5D=string&country=US' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

レスポンス

仮想通貨のリストが正常に受信されました。

ボディapplication/json
itemsArray of objects(Catalog_inline_response_200_6_items)
例: [{"attributes":[{"external_id":"stack_size","name":"Stack size","values":[{"value":"5"}]}],"description":"Big Rocket - short description","groups":[{"external_id":"accessory","name":"Accessory"}],"image_url":"https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png","inventory_options":{"consumable":{"usages_count":1}},"is_free":false,"name":"Big Rocket","price":{"amount":"100.99","amount_without_discount":"100.99","currency":"USD"},"sku":"big_rocket","type":"virtual_currency","virtual_prices":[{"amount":100,"amount_without_discount":100,"description":"description","image_url":"http://image.png","is_default":true,"name":"SHOTGUN FOR TRUE RAIDERS","sku":"shotgun_raider","type":"virtual_currency"}]},{"attributes":[{"external_id":"stack_size","name":"Stack size","values":[{"value":"1"}]},{"external_id":"rating","name":"Rating","values":[{"value":"3.9"}]},{"external_id":"genre","name":"Genre","values":[{"value":"Strategy"},{"value":"Tactical"},"Turn-based"]}],"description":"description","groups":[{"external_id":"hair","name":"Hair"}],"image_url":"http://image.png","inventory_options":{"consumable":{"usages_count":1}},"is_free":false,"name":"SHOTGUN FOR TRUE RAIDERS","price":{"amount":"101.0","amount_without_discount":"101.0","currency":"USD"},"sku":"shotgun_raider","type":"virtual_currency","virtual_prices":[]},{"attributes":[],"description":"description","groups":[],"image_url":"http://image.png","inventory_options":{"consumable":{"usages_count":1}},"is_free":true,"name":"SHOTGUN FOR TRUE RAIDERS","sku":"shotgun_raider_2","type":"virtual_currency","virtual_prices":[]}]
items[].​attributesArray of objects(Catalog_client-attributes)

ゲームに対応する属性とその値のリスト。

注意。応答のこの部分は、`additional_fields[] = attributes`クエリパラメータを送信した場合にのみ使用できます。
デフォルト []
items[].​attributes[].​external_idstring(Catalog_admin-attribute-external_id)[ 1 .. 255 ] characters^[a-zA-Z0-9-_]+$

一意の属性ID。external_idには、小文字のラテン英数字、ダッシュ、およびアンダースコアのみを含めることができます。

例: "attribute_1"
items[].​attributes[].​namestring

属性の名前。

例: "Genre"
items[].​attributes[].​valuesArray of objects
items[].​attributes[].​values[].​external_idstring(Catalog_value-external_id)[ 1 .. 255 ] characters^[-_.\d\w]+$

属性の一意の値ID。external_idには、小文字のラテン英数字、ダッシュ、およびアンダースコアのみを含めることができます。

例: "attribute_value"
items[].​attributes[].​values[].​valuestring

属性の値。

例: "Strategy"
items[].​descriptionstring

アイテム説明。

例: "Big Rocket - description"
items[].​groupsArray of objects(Catalog_inline_response_200_groups)

アイテムが属するグループ。

例: [{"external_id":"accessory","name":"Accessory"}]
items[].​groups[].​external_idstring
例: "accessory"
items[].​groups[].​namestring
例: "Accessory"
items[].​image_urlstring

画像のURL。

例: "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png"
items[].​inventory_optionsobject(Catalog_inline_response_200_5_inventory_options)

インベントリアイテムオプションを定義します。

items[].​inventory_options.​consumableobject or null(Catalog_inline_response_200_5_inventory_options_consumable)

消耗品の場合は消耗品のプロパティを、非消耗品の場合はnullを定義します。

items[].​inventory_options.​consumable.​usages_countinteger or null

消耗品の場合は残りの総使用回数、非消耗品の場合はnullとなります。

例: 1
items[].​inventory_options.​expiration_periodobject or null(Catalog_inline_response_200_5_inventory_options_expiration_period)

期限付きアイテムの場合は有効期限のプロパティを定義し、期限のないアイテムの場合はnullを定義します。

items[].​inventory_options.​expiration_period.​typestring

アイテムの有効期限のタイプを定義します。

列挙型"minute""hour""day""week""month""year"
例: "day"
items[].​inventory_options.​expiration_period.​valueinteger

有効期限の値を定義します。

例: 1
items[].​is_freestring

trueの場合、アイテムは無料です。

例: "false"
items[].​namestring

アイテム名。

例: "Big Rocket"
items[].​priceobject(Catalog_inline_response_200_5_price)

アイテム価格。

items[].​price.​amountstring

割引商品価格。

例: "100.99"
items[].​price.​amount_without_discountstring

アイテム価格。

例: "100.99"
items[].​price.​currencystring

デフォルトの購入通貨。ISO 4217ごとの3文字のコード。

例: "USD"
items[].​skustring

一意のアイテムID。SKUには、小文字のラテン英数字、ピリオド、ダッシュ、およびアンダースコアのみを含めることができます。

例: "big_rocket"
items[].​typestring

アイテムのタイプ：virtual_good/virtual_currency/bundle。

例: "virtual_currency"
items[].​virtual_pricesArray of objects(Catalog_inline_response_200_virtual_prices)

仮想価格。

例: [{"amount":100,"amount_without_discount":100,"image_url":"http://image.png","is_default":true,"sku":"shotgun_raider"}]
items[].​virtual_prices[].​amountinteger

仮想通貨での割引アイテム価格。

例: 100
items[].​virtual_prices[].​amount_without_discountinteger

アイテム価格。

例: 200
items[].​virtual_prices[].​descriptionstring

仮想通貨の説明。

例: "Big Rocket - description"
items[].​virtual_prices[].​image_urlstring

仮想通貨の画像。

例: "http://image.png"
items[].​virtual_prices[].​is_defaultboolean

アイテムの価格がデフォルトであるかどうか。

例: true
items[].​virtual_prices[].​namestring

仮想通貨名。

例: "SHOTGUN FOR TRUE RAIDERS"
items[].​virtual_prices[].​skustring

仮想通貨アイテムSKU。

例: "vc_test"
items[].​virtual_prices[].​typestring

仮想通貨タイプ。

例: "virtual_currency"
レスポンス
application/json
{
  "items": [
    { … },
    { … },
    { … }
  ]
}

仮想通貨パッケージリストを取得する

リクエスト

カタログを作成するための仮想通貨パッケージリストを取得します。

注意すべてのプロジェクトには、応答で取得できるアイテムの数に制限があります。デフォルトおよび最大値は応答あたり50アイテムです。ページごとにより多くのデータを取得するには、制限フィールドとオフセットフィールドを使用します。
セキュリティ
AuthForClient
パス
project_idinteger必須

プロジェクトID。

例: 44056
クエリ
limitinteger

ページにある要素数の制限。

例: limit=50
offsetinteger

リストが生成される要素の番号（0からカウントされる）。

例: offset=0
localestring

応答言語。ISO639-1に準拠した2文字の小文字の言語コード。

デフォルト "en"
additional_fields[]Array of strings

追加フィールドのリスト。これらのフィールドは、リクエストで送信した場合、応答に含まれます。利用可能なフィールドmedia_list、order、long_descriptionです。

countrystring

カタログの地域別価格と制限を計算するための国。ISO 3166-1 alpha-2に準拠した2文字の大文字の国コードです。国を明示的に指定しない場合は、ユーザーのIPアドレスに基づいて計算されます。

デフォルト "US"
curl -i -X GET \
  'https://store.xsolla.com/api/v2/project/44056/items/virtual_currency/package?limit=50&offset=0&locale=en&additional_fields%5B%5D=string&country=US' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

レスポンス

仮想通貨パッケージのリストが正常に受信されました。

ボディapplication/json
itemsArray of objects(Catalog_inline_response_200_7_items)
例: [{"attributes":[],"bundle_type":"virtual_currency_package","content":[{"description":"Big Rocket - short description","image_url":"https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png","inventory_options":{"consumable":{"usages_count":1}},"name":"Big Rocket","quantity":100,"sku":"big_rocket","type":"virtual_currency"}],"description":"VC Short Package Description","groups":[],"image_url":"http://vc_package_image.png","is_free":false,"name":"VC Name first package","price":{"amount":"2.0000","amount_without_discount":"2.0000","currency":"USD"},"sku":"vc_package_1","type":"bundle","virtual_prices":[]},{"attributes":[],"bundle_type":"virtual_currency_package","content":[{"description":"description","image_url":"http://image.png","inventory_options":{"consumable":{"usages_count":1}},"name":"SHOTGUN FOR TRUE RAIDERS","quantity":200,"sku":"shotgun_raider","type":"virtual_currency"}],"description":"VC Short Package Description","groups":[],"image_url":"http://vc_package_image.png","is_free":false,"name":"VC Name third package","price":{"amount":"4.0000","amount_without_discount":"4.0000","currency":"USD"},"sku":"vc_package_3","type":"bundle","virtual_prices":[]}]
items[].​attributesArray of objects(Catalog_client-attributes)

ゲームに対応する属性とその値のリスト。

注意。応答のこの部分は、`additional_fields[] = attributes`クエリパラメータを送信した場合にのみ使用できます。
デフォルト []
items[].​attributes[].​external_idstring(Catalog_admin-attribute-external_id)[ 1 .. 255 ] characters^[a-zA-Z0-9-_]+$

一意の属性ID。external_idには、小文字のラテン英数字、ダッシュ、およびアンダースコアのみを含めることができます。

例: "attribute_1"
items[].​attributes[].​namestring

属性の名前。

例: "Genre"
items[].​attributes[].​valuesArray of objects
items[].​attributes[].​values[].​external_idstring(Catalog_value-external_id)[ 1 .. 255 ] characters^[-_.\d\w]+$

属性の一意の値ID。external_idには、小文字のラテン英数字、ダッシュ、およびアンダースコアのみを含めることができます。

例: "attribute_value"
items[].​attributes[].​values[].​valuestring

属性の値。

例: "Strategy"
items[].​bundle_typestring

バンドルのタイプ：standard/virtual_currency_package。

例: "virtual_currency_package"
items[].​contentArray of objects(Catalog_inline_response_200_7_content)

仮想通貨パッケージのコンテンツ。

例: [{"description":"Big Rocket - short description","image_url":"https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png","inventory_options":{"consumable":{"usages_count":1}},"name":"Big Rocket","quantity":100,"sku":"big_rocket","type":"virtual_currency"}]
items[].​content[].​descriptionstring

アイテム説明。

例: "Big Rocket - description"
items[].​content[].​image_urlstring

画像のURL。

例: "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png"
items[].​content[].​inventory_optionsobject(Catalog_inline_response_200_7_inventory_options)

インベントリアイテムオプションを定義します。

items[].​content[].​inventory_options.​consumableobject or null(Catalog_inline_response_200_5_inventory_options_consumable)

消耗品の場合は消耗品のプロパティを、非消耗品の場合はnullを定義します。

items[].​content[].​inventory_options.​consumable.​usages_countinteger or null

消耗品の場合は残りの総使用回数、非消耗品の場合はnullとなります。

例: 1
items[].​content[].​inventory_options.​expiration_periodobject or null(Catalog_inline_response_200_7_inventory_options_expiration_period)

期限付きアイテムの場合は有効期限のプロパティを定義し、期限のないアイテムの場合はnullを定義します。

items[].​content[].​inventory_options.​expiration_period.​typestring

アイテムの有効期限のタイプを定義します。

列挙型"minute""hour""day""week""month""year"
例: "day"
items[].​content[].​inventory_options.​expiration_period.​valueinteger

有効期限の値を定義します。

例: 1
items[].​content[].​namestring

アイテム名。

例: "Big Rocket"
items[].​content[].​quantityinteger

パッケージ内の仮想通貨の数量。

例: 250
items[].​content[].​skustring

一意のアイテムID。SKUには、小文字のラテン英数字、ダッシュ、およびアンダースコアのみを含めることができます。

例: "big_rocket"
items[].​content[].​typestring

アイテムのタイプ：virtual_good/virtual_currency/bundle。

例: "virtual_currency"
items[].​descriptionstring

アイテム説明。

例: "Big Rocket - description"
items[].​groupsArray of objects(Catalog_inline_response_200_groups)

アイテムが属するグループ。

例: [{"external_id":"accessory","name":"Accessory"}]
items[].​groups[].​external_idstring
例: "accessory"
items[].​groups[].​namestring
例: "Accessory"
items[].​image_urlstring

画像のURL。

例: "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png"
items[].​is_freestring

trueの場合、アイテムは無料です。

例: "false"
items[].​namestring

アイテム名。

例: "Big Rocket"
items[].​priceobject(Catalog_inline_response_200_5_price)

アイテム価格。

items[].​price.​amountstring

割引商品価格。

例: "100.99"
items[].​price.​amount_without_discountstring

アイテム価格。

例: "100.99"
items[].​price.​currencystring

デフォルトの購入通貨。ISO 4217ごとの3文字のコード。

例: "USD"
items[].​skustring

一意のアイテムID。SKUには、小文字のラテン英数字、ピリオド、ダッシュ、およびアンダースコアのみを含めることができます。

例: "big_rocket"
items[].​typestring

アイテムのタイプ：virtual_good/virtual_currency/bundle。

例: "bundle"
items[].​virtual_pricesArray of objects(Catalog_inline_response_200_virtual_prices)

仮想価格。

items[].​virtual_prices[].​amountinteger

仮想通貨での割引アイテム価格。

例: 100
items[].​virtual_prices[].​amount_without_discountinteger

アイテム価格。

例: 200
items[].​virtual_prices[].​descriptionstring

仮想通貨の説明。

例: "Big Rocket - description"
items[].​virtual_prices[].​image_urlstring

仮想通貨の画像。

例: "http://image.png"
items[].​virtual_prices[].​is_defaultboolean

アイテムの価格がデフォルトであるかどうか。

例: true
items[].​virtual_prices[].​namestring

仮想通貨名。

例: "SHOTGUN FOR TRUE RAIDERS"
items[].​virtual_prices[].​skustring

仮想通貨アイテムSKU。

例: "vc_test"
items[].​virtual_prices[].​typestring

仮想通貨タイプ。

例: "virtual_currency"
レスポンス
application/json
{
  "items": [
    { … },
    { … }
  ]
}

バンドル

操作

ユーザートークン

操作

通知

操作

注文

操作