Catalog API (2.0.0)
- バージョン： 2.0.0
- サーバー：
https://store.xsolla.com/api - メールでお問い合わせ
- 連絡先URL： https://xsolla.com/
- 要求されるTLSバージョン： 1.2
カタログAPIを使用すると、ゲーム内アイテムのカタログをエクソーラ側で設定し、そのカタログをストア内でユーザーに表示することができます。
本APIでは、以下のカタログエンティティを管理できます：
- 仮想アイテム — 武器、スキン、ブースターなどのゲーム内アイテム。
- 仮想通貨 — 仮想商品の購入に使用される仮想通貨。
- 仮想通貨パッケージ — 事前定義された仮想通貨のバンドル。
- バンドル — 仮想アイテム、通貨、またはゲームキーを1つのSKUとしてまとめたパッケージ。
- ゲームキー — Steamやその他のDRMプロバイダーを通じて配布される、ゲームおよびDLCのキー。
- グループ — カタログ内のアイテムを整理または並べ替えするための論理的なグループ分け。
本APIは、以下のグループに分かれています：
Admin — カタログアイテムやグループの作成、更新、削除、および設定を行うためのコール。マーチャントまたはプロジェクトの認証情報による基本アクセス認証で認証されます。ストアフロントでの使用は想定されていません。Catalog — アイテムの取得や、エンドユーザー向けのカスタムストアフロントを構築するためのコール。高負荷なシナリオに対応できるよう設計されています。ユーザー個別の制限事項や実施中のプロモーションなど、パーソナライズされたデータを返すための、ユーザーJWTによる任意認証をサポートしています。
OpenAPI記述をダウンロード
言語
サーバー
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/ja/api/catalog/
- https://store.xsolla.com/api/v2/project/{project_id}/items/groups
- Mock serverhttps://xsolla.redocly.app/_mock/ja/api/catalog/v2/project/{project_id}/items/groups
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://store.xsolla.com/api/v2/project/44056/items/groups?promo_code=WINTER2021'グループのリストは正常に受信されました。
例: [{"children":[{"children":[{"children":[],"description":"Accessory","external_id":"accessory","image_url":null,"level":2,"name":"Accessory","order":1,"parent_external_id":"background"}],"description":"Background description","external_id":"background","image_url":null,"level":1,"name":"Background","order":1,"parent_external_id":"hair"}],"description":"Hair description","external_id":"hair","image_url":null,"level":0,"name":"Hair","order":1,"parent_external_id":null},{"children":[],"description":"Super description","external_id":"group_external_id","image_url":null,"level":0,"name":"Super","order":1,"parent_external_id":null}]
レスポンス
application/json
{ "groups": [ { … }, { … }, { … }, { … }, { … }, { … }, { … }, { … } ] }
クエリ
追加フィールドのリスト。これらのフィールドは、リクエストの中で送信すると、応答に含まれます。
アイテム 列挙型"media_list""order""long_description""custom_attributes""item_order_in_group"
ISO 3166-1 alpha-2に従った2文字の大文字の国名コード。エクソーラがサポートする国と国を決定するプロセスに関する詳細情報については、ドキュメントを確認してください。
例: country=US
- https://store.xsolla.com/api/v2/project/{project_id}/items/virtual_currency
- Mock serverhttps://xsolla.redocly.app/_mock/ja/api/catalog/v2/project/{project_id}/items/virtual_currency
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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=media_list&country=US&promo_code=WINTER2021&show_inactive_time_limited_items=1' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'レスポンス
application/json
{ "has_more": false, "items": [ { … }, { … }, { … } ] }
クエリ
追加フィールドのリスト。これらのフィールドは、リクエストの中で送信すると、応答に含まれます。
アイテム 列挙型"media_list""order""long_description""custom_attributes""item_order_in_group"
ISO 3166-1 alpha-2に従った2文字の大文字の国名コード。エクソーラがサポートする国と国を決定するプロセスに関する詳細情報については、ドキュメントを確認してください。
例: country=US
- https://store.xsolla.com/api/v2/project/{project_id}/items/virtual_currency/package
- Mock serverhttps://xsolla.redocly.app/_mock/ja/api/catalog/v2/project/{project_id}/items/virtual_currency/package
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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=media_list&country=US&promo_code=WINTER2021&show_inactive_time_limited_items=1' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'レスポンス
application/json
{ "has_more": false, "items": [ { … }, { … } ] }