コンテンツへスキップ
/
ゲームリストを取得する

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/

カート

操作

ゲームキー

操作

ゲームリストを取得する

リクエスト

カタログを作成するためのゲームリストを取得します。

注意すべてのプロジェクトには、応答で取得できるアイテムの数に制限があります。デフォルトおよび最大値は1応答あたり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/game?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_items)
例: [{"attributes":{"$ref":"#/components/examples/client-attribute-game/Catalog_value"},"description":"Game description","groups":[{"external_id":"all","name":"All games"},{"external_id":"Xsolla","name":"Xsolla games"}],"image_url":"https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png","name":"Game name","sku":"game_1","type":"unit","unit_items":[{"drm_name":"Steam","drm_sku":"steam","has_keys":true,"is_free":false,"is_pre_order":true,"price":{"amount":"30.5","amount_without_discount":"30.5","currency":"USD"},"release_date":"2020-08-11T10:00:00+03:00","sku":"game_key_01","type":"game_key","virtual_prices":[]},{"drm_name":"Origin","drm_sku":"origin","has_keys":false,"is_free":false,"is_pre_order":false,"price":{"amount":"30.5","amount_without_discount":"30.5","currency":"USD"},"sku":"game_key_02","type":"game_key","virtual_prices":[]}],"unit_type":"game"},{"attributes":[{"external_id":"OS","name":"OS","values":[{"external_id":"9d5c5efb7c0f00a00fe4e3583f1215b0050bc723","value":"Windows"}]}],"description":"Game description","groups":[{"external_id":"all","name":"All games"}],"image_url":"https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png","name":"Game name","sku":"game_2","type":"unit","unit_items":[{"drm_name":"Steam","drm_sku":"steam","has_keys":false,"is_free":false,"is_pre_order":false,"price":{"amount":"30.5","amount_without_discount":"30.5","currency":"USD"},"sku":"game_key_01","type":"game_key","virtual_prices":[]}],"unit_type":"game"}]
items[].​attributesArray of objects(Catalog_client-attributes-common)

アイテムに対応する属性とその値のリスト。カタログのフィルタリングに使用できます。

デフォルト []
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

アイテム説明。

例: "Game description"
items[].​groupsArray of objects(Catalog_inline_response_200_groups)

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

例: [{"external_id":"all","name":"All games"},{"external_id":"Xsolla","name":"Xsolla game"}]
items[].​groups[].​external_idstring
例: "accessory"
items[].​groups[].​namestring
例: "Accessory"
items[].​image_urlstring

画像のURL。

例: "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png"
items[].​namestring

アイテム名。

例: "Game name"
items[].​skustring

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

例: "game_01"
items[].​typestring

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

例: "unit"
items[].​unit_itemsArray of objects(Catalog_inline_response_200_unit_items)
items[].​unit_items[].​drm_namestring

DRM名。

例: "Steam"
items[].​unit_items[].​drm_skustring

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

例: "steam"
items[].​unit_items[].​has_keysboolean

trueの場合、ゲームキーには販売用のキーがあります。

例: false
items[].​unit_items[].​is_freeboolean

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

例: false
items[].​unit_items[].​is_pre_orderboolean

trueの場合、ゲームキーは先行予約済みで、リリース日は過ぎていません。

例: true
items[].​unit_items[].​priceobject(Catalog_inline_response_200_price)

アイテム価格。

items[].​unit_items[].​price.​amountstring

割引商品価格。

例: "2.9900"
items[].​unit_items[].​price.​amount_without_discountstring

アイテム価格。

例: "2.9900"
items[].​unit_items[].​price.​currencystring

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

例: "USD"
items[].​unit_items[].​release_datestring

ISO8601形式のゲームキーのリリース日。

例: "2020-08-11T10:00:00+03:00"
items[].​unit_items[].​skustring

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

例: "game_01"
items[].​unit_items[].​typestring

アイテムのタイプ：game_key。

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

仮想価格。

items[].​unit_items[].​virtual_prices[].​amountinteger

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

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

アイテム価格。

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

仮想通貨の説明。

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

仮想通貨の画像。

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

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

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

仮想通貨名。

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

仮想通貨アイテムSKU。

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

仮想通貨タイプ。

例: "virtual_currency"
items[].​unit_typestring

ユニットのタイプ：game。

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

DRMリストを取得する

リクエスト

使用可能なDRMのリストを取得します。

セキュリティ
AuthForClient
パス
project_idinteger必須

プロジェクトID。

例: 44056
curl -i -X GET \
  https://store.xsolla.com/api/v2/project/44056/items/game/drm \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

レスポンス

DRMリストが正常に受信されました。

ボディapplication/json
drmArray of objects(Catalog_inline_response_200_4_drm)
例: [{"drm_id":1,"image":"https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png","link":"https://support.steampowered.com","name":"Steam","redeem_instruction_link":"https://support.steampowered.com","sku":"steam"},{"drm_id":2,"image":"https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png","name":"Playstation","redeem_instruction_link":"https://support.us.playstation.com","sku":"playstation"}]
drm[].​drm_idnumber

DRM ID。

例: 1
drm[].​imagestring

画像のURL。

例: "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png"
drm[].​linkstring

引き換えリンク。

例: "https://support.us.playstation.com"
drm[].​namestring

DRM名。

例: "Steam"
drm[].​redeem_instruction_linkstring

引き換え説明リンク。

例: "https://support.us.playstation.com"
drm[].​skustring

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

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

指定されたグループごとにゲームリストを取得する

リクエスト

カタログを作成するために、指定されたグループからゲームリストを取得します。

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

プロジェクトID。

例: 44056
external_idstring必須

グループ外部ID。

デフォルト "all"
クエリ
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/game/group/{external_id}?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_items)
例: [{"attributes":{"$ref":"#/components/examples/client-attribute-game/Catalog_value"},"description":"Game description","groups":[{"external_id":"all","name":"All games"},{"external_id":"Xsolla","name":"Xsolla games"}],"image_url":"https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png","name":"Game name","sku":"game_1","type":"unit","unit_items":[{"drm_name":"Steam","drm_sku":"steam","has_keys":true,"is_free":false,"is_pre_order":true,"price":{"amount":"30.5","amount_without_discount":"30.5","currency":"USD"},"release_date":"2020-08-11T10:00:00+03:00","sku":"game_key_01","type":"game_key","virtual_prices":[]},{"drm_name":"Origin","drm_sku":"origin","has_keys":false,"is_free":false,"is_pre_order":false,"price":{"amount":"30.5","amount_without_discount":"30.5","currency":"USD"},"sku":"game_key_02","type":"game_key","virtual_prices":[]}],"unit_type":"game"},{"attributes":[{"external_id":"OS","name":"OS","values":[{"external_id":"9d5c5efb7c0f00a00fe4e3583f1215b0050bc723","value":"Windows"}]}],"description":"Game description","groups":[{"external_id":"all","name":"All games"}],"image_url":"https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png","name":"Game name","sku":"game_2","type":"unit","unit_items":[{"drm_name":"Steam","drm_sku":"steam","has_keys":false,"is_free":false,"is_pre_order":false,"price":{"amount":"30.5","amount_without_discount":"30.5","currency":"USD"},"sku":"game_key_01","type":"game_key","virtual_prices":[]}],"unit_type":"game"}]
items[].​attributesArray of objects(Catalog_client-attributes-common)

アイテムに対応する属性とその値のリスト。カタログのフィルタリングに使用できます。

デフォルト []
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

アイテム説明。

例: "Game description"
items[].​groupsArray of objects(Catalog_inline_response_200_groups)

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

例: [{"external_id":"all","name":"All games"},{"external_id":"Xsolla","name":"Xsolla game"}]
items[].​groups[].​external_idstring
例: "accessory"
items[].​groups[].​namestring
例: "Accessory"
items[].​image_urlstring

画像のURL。

例: "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png"
items[].​namestring

アイテム名。

例: "Game name"
items[].​skustring

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

例: "game_01"
items[].​typestring

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

例: "unit"
items[].​unit_itemsArray of objects(Catalog_inline_response_200_unit_items)
items[].​unit_items[].​drm_namestring

DRM名。

例: "Steam"
items[].​unit_items[].​drm_skustring

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

例: "steam"
items[].​unit_items[].​has_keysboolean

trueの場合、ゲームキーには販売用のキーがあります。

例: false
items[].​unit_items[].​is_freeboolean

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

例: false
items[].​unit_items[].​is_pre_orderboolean

trueの場合、ゲームキーは先行予約済みで、リリース日は過ぎていません。

例: true
items[].​unit_items[].​priceobject(Catalog_inline_response_200_price)

アイテム価格。

items[].​unit_items[].​price.​amountstring

割引商品価格。

例: "2.9900"
items[].​unit_items[].​price.​amount_without_discountstring

アイテム価格。

例: "2.9900"
items[].​unit_items[].​price.​currencystring

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

例: "USD"
items[].​unit_items[].​release_datestring

ISO8601形式のゲームキーのリリース日。

例: "2020-08-11T10:00:00+03:00"
items[].​unit_items[].​skustring

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

例: "game_01"
items[].​unit_items[].​typestring

アイテムのタイプ：game_key。

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

仮想価格。

items[].​unit_items[].​virtual_prices[].​amountinteger

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

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

アイテム価格。

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

仮想通貨の説明。

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

仮想通貨の画像。

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

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

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

仮想通貨名。

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

仮想通貨アイテムSKU。

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

仮想通貨タイプ。

例: "virtual_currency"
items[].​unit_typestring

ユニットのタイプ：game。

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

仮想アイテム & 通貨

操作

バンドル

操作

ユーザートークン

操作

通知

操作

注文

操作