コンテンツへスキップ

Catalog API (2.0.0)

Overview

  • Version: 2.0.0
  • Servers: https://store.xsolla.com/api
  • Contact Us by Email
  • Contact URL: https://xsolla.com/
  • Required TLS version: 1.2

Catalog APIは、ゲーム内ストアカタログを管理し、購入を処理するためのエンドポイントを提供します。エンドポイントを使用して、仮想アイテム、仮想通貨、ゲームキー、バンドル、カートと決済フロー、アイテムアトリビュート、および外部ソースからのアイテムのインポートを設定できます。

OpenAPI記述をダウンロード
言語
サーバー
Mock server
https://xsolla.redocly.app/_mock/ja/api/catalog/
https://store.xsolla.com/api/
操作
操作
操作
操作
操作
操作

コードをアップロードServer-sideAdmin

リクエスト

ゲームキーSKUによるコードをアップロードします。

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

プロジェクトID。このパラメータは、パブリッシャーアカウントのプロジェクト名の横にあります。

例: 44056
item_skustring必須

アイテムSKU。

例: booster_mega_1
ボディmultipart/form-data必須
filestring(binary)必須

コードを含むファイル。

例: "keys.txt"
region_idinteger

リージョンID。

例: 1
curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ja/api/catalog/v2/project/44056/admin/items/game/key/upload/sku/booster_mega_1 \
  -H 'Content-Type: multipart/form-data' \
  -F file=keys.txt \
  -F region_id=1

レスポンス

セッション情報を読み込むコードが正常に受信されました。

ボディapplication/json
count_skippedinteger
例: 10
count_totalinteger
例: 100
count_uploadedinteger
例: 0
session_idstring
例: "fc7105b6e8ee01339582970b37697242"
statusstring
例: "processing"
レスポンス
application/json
{ "count_skipped": 10, "count_total": 100, "count_uploaded": 0, "session_id": "fc7105b6e8ee01339582970b37697242", "status": "processing" }

ゲームをSKUで削除Server-sideAdmin

リクエスト

SKUによるプロジェクト内のゲームを削除します。

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

プロジェクトID。このパラメータは、パブリッシャーアカウントのプロジェクト名の横にあります。

例: 44056
item_skustring必須

アイテムSKU。

例: booster_mega_1
curl -i -X DELETE \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ja/api/catalog/v2/project/44056/admin/items/game/sku/booster_mega_1

レスポンス

ゲームは正常に削除されました。

レスポンス
コンテンツなし

ゲームを取得する(管理者)Server-sideAdmin

リクエスト

管理用ゲームを取得します。 ゲームは、ユーザーが購入可能なゲームキーで構成されています。

注意

このエンドポイントは、ストアカタログの構築に使用しないでください。
セキュリティ
basicAuth
パス
project_idinteger必須

プロジェクトID。このパラメータは、パブリッシャーアカウントのプロジェクト名の横にあります。

例: 44056
item_skustring必須

アイテムSKU。

例: booster_mega_1
クエリ
promo_codestring[ 1 .. 128 ] characters

大文字と小文字を区別する一意のコードです。文字と数字が含まれます。

例: promo_code=WINTER2021
curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ja/api/catalog/v2/project/44056/admin/items/game/sku/booster_mega_1?promo_code=WINTER2021'

レスポンス

ゲームは正常に受信されました。

ボディapplication/json
attributesArray of objects(Game-Keys_admin-attributes)

属性リスト。

例: [{"external_id":"attribute_external_id","name":{"de":"Attributname","en":"Attribute name"},"values":[{"external_id":"value_1","name":{"de":"wert 1","en":"value 1"}},{"external_id":"value_2","name":{"de":"wert 2","en":"value 2"}}]}]
description(two-letter (object or null)) or (five-letter (object or null))(description-localization-object)

アイテムの説明に関するローカライズ用オブジェクト。2文字の小文字の言語コード(例:en)または5文字のロケールコード(例:en-US)のいずれかの形式で値を受け入れます。どちらの形式も入力として受け入れられますが、応答は2文字の小文字の言語コードを返します。同じ言語に対して両方のオプションが提供された場合(例:enen-US)、最後に提供された値が保存されます。サポートされている言語の完全なリストは、ドキュメントで確認できます。

One of:

アイテムの説明に関するローカライズ用オブジェクト。2文字の小文字の言語コード(例:en)または5文字のロケールコード(例:en-US)のいずれかの形式で値を受け入れます。どちらの形式も入力として受け入れられますが、応答は2文字の小文字の言語コードを返します。同じ言語に対して両方のオプションが提供された場合(例:enen-US)、最後に提供された値が保存されます。サポートされている言語の完全なリストは、ドキュメントで確認できます。

groupsArray of objects

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

例: [{"external_id":"horror","name":{"en":"Horror"}}]
image_urlstring

画像URL。

例: "https://image.example.com"
is_enabledboolean
is_freeboolean(value-is_free)

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

デフォルト false
例: false
is_show_in_storeboolean
item_idinteger

アイテム作成時に付与される内部一意のアイテムID。

例: 1
long_description(two-letter (object or null)) or (five-letter (object or null))(long-description-localization-object)

アイテムの長文説明のローカライズを含むオブジェクト。2文字の小文字の言語コード(例:en)または5文字のロケールコード(例:en-US)のいずれかの形式で値を受け入れます。どちらの形式も入力として受け入れられますが、応答は2文字の小文字の言語コードを返します。同じ言語に対して両方のバリアント(例:enen-US)が提供された場合、最後に提供された値が保存されます。サポートされている言語の完全なリストは、ドキュメントで確認できます。

Any of:

アイテムの長文説明のローカライズを含むオブジェクト。2文字の小文字の言語コード(例:en)または5文字のロケールコード(例:en-US)のいずれかの形式で値を受け入れます。どちらの形式も入力として受け入れられますが、応答は2文字の小文字の言語コードを返します。同じ言語に対して両方のバリアント(例:enen-US)が提供された場合、最後に提供された値が保存されます。サポートされている言語の完全なリストは、ドキュメントで確認できます。

media_listArray of objects

スクリーンショット、ゲームプレイ動画などのゲーム追加アセット。

例: [{"type":"image","url":"https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg"}]
name(two-letter (object or null)) or (five-letter (object or null))(name-localization-object)

アイテム名に関するローカライズ用オブジェクト。2文字の小文字の言語コード(例:en)または5文字の言語コード(例:en-US)のいずれかの形式で値を受け入れます。どちらの形式も入力として受け入れられますが、応答は2文字の小文字の言語コードを返します。同じ言語に対して両方のオプションが提供された場合(例:enen-US)、最後に提供された値が保存されます。サポートされている言語の完全なリストは、ドキュメントで確認できます。

One of:

アイテム名に関するローカライズ用オブジェクト。2文字の小文字の言語コード(例:en)または5文字の言語コード(例:en-US)のいずれかの形式で値を受け入れます。どちらの形式も入力として受け入れられますが、応答は2文字の小文字の言語コードを返します。同じ言語に対して両方のオプションが提供された場合(例:enen-US)、最後に提供された値が保存されます。サポートされている言語の完全なリストは、ドキュメントで確認できます。

orderinteger

リスト内のゲーム順の優先順位。

例: 1
skustring

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

例: "game_1"
typestring

アイテムタイプ。 この場合、それは常にunitです。

例: "unit"
unit_itemsArray of objects

異なるDRMに対応したゲームキー。

レスポンス
application/json
{ "attributes": [ {} ], "description": { "en": "Example game 1" }, "groups": [ {} ], "image_url": "https://image.example.com", "is_enabled": true, "is_free": false, "is_show_in_store": false, "item_id": 1, "long_description": { "en": "Example game's long description" }, "media_list": [ {} ], "name": { "en": "Game 1" }, "order": 1, "sku": "com.xsolla.game_1", "type": "unit", "unit_items": [ {}, {} ] }
操作
操作

カート(クライアント側)

操作

カート(サーバー側)

操作

決済(クライアント側)

操作

決済(サーバー側)

操作
操作

無料アイテム

操作
操作
操作

ウェブフック

操作
操作

マーチャント

操作

カタログ

このAPIは販売可能なアイテムや特定のアイテムを取得することができます。

操作
操作
操作