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}/admin/webhook
- Mock serverhttps://xsolla.redocly.app/_mock/ja/api/catalog/v2/project/{project_id}/admin/webhook
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
https://store.xsolla.com/api/v2/project/44056/admin/webhookレスポンス
application/json
{ "is_enabled": true, "secret": "my_secret", "url": "http://site.ru/webhook" }
ボディapplication/json必須
ウェブフック設定に関する情報。
ゲームサービスのウェブフックが有効かどうか。
ゲームサービス のウェブフックの場合、このAPIコールで指定された設定は、プロジェクト設定 > ウェブフックセクションのパブリッシャーアカウントで構成された設定よりも優先されます。
例: true
ゲームサービスのウェブフックに署名するためのプロジェクトの秘密鍵です。
ゲームサービスでは、このAPIコールで指定された鍵が、プロジェクト設定 > ウェブフックセクションのパブリッシャーアカウントで生成された鍵よりも優先されます。
例: "my_secret_key"
ゲームサービスのウェブフックを受信するためのサーバーのURL。URL は一般にアクセス可能で、HTTPS プロトコル (https://example.comなど) を使用する必要があります。また、ウェブフックをテストするためのツールで見つけたURLを指定することもできます。
ゲームサービスのウェブフックでは、このAPIコールで指定された設定が、プロジェクト設定 > ウェブフックセクションのパブリッシャーアカウントで構成された設定よりも優先されます。
例: "http://site.ru/webhook"
ウェブフックのバージョン。バージョン2では、アイテム配列には、バージョン1(デフォルト)には存在しないパラメータis_free、is_bonus、およびis_bundle_contentが含まれています。
列挙型12
例: 1
- https://store.xsolla.com/api/v2/project/{project_id}/admin/webhook
- Mock serverhttps://xsolla.redocly.app/_mock/ja/api/catalog/v2/project/{project_id}/admin/webhook
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
-u <username>:<password> \
https://store.xsolla.com/api/v2/project/44056/admin/webhook \
-H 'Content-Type: application/json' \
-d '{
"is_enabled": true,
"secret": "my_secret_key",
"url": "http://site.ru/webhook",
"version": 1
}'