コンテンツへスキップ

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コール

本APIは、以下のグループに分かれています:

  • Admin — カタログアイテムやグループの作成、更新、削除、および設定を行うためのコール。マーチャントまたはプロジェクトの認証情報による基本アクセス認証で認証されます。ストアフロントでの使用は想定されていません。
  • Catalog — アイテムの取得や、エンドユーザー向けのカスタムストアフロントを構築するためのコール。高負荷なシナリオに対応できるよう設計されています。ユーザー個別の制限事項や実施中のプロモーションなど、パーソナライズされたデータを返すための、ユーザーJWTによる任意認証をサポートしています。
OpenAPI記述をダウンロード
言語
サーバー
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/ja/api/catalog/
操作
操作
操作
操作
操作
操作
操作
操作

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

操作

カート(サーバー側)

操作

決済(クライアント側)

操作

決済(サーバー側)

操作
操作

無料アイテム

操作
操作
操作

ウェブフック

操作

ウェブフック設定に関する情報を取得Server-sideAdmin

リクエスト

ストアのウェブフック設定に関する情報を取得します。 詳しくは、ウェブフックのドキュメントをご覧ください。

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

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

例: 44056
curl -i -X GET \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/webhook

レスポンス

ウェブフック設定に関する情報は正常に受信されました。

ボディapplication/json
is_enabledboolean
例: true
secretstring
例: "my_secret"
urlstring
例: "http://site.ru/webhook"
レスポンス
application/json
{ "is_enabled": true, "secret": "my_secret", "url": "http://site.ru/webhook" }

ウェブフック設定に関する情報を更新Server-sideAdmin

リクエスト

ストアのウェブフック設定に関する情報を更新します。 詳しくは、ウェブフックのドキュメントをご覧ください。

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

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

例: 44056
ボディapplication/json必須

ウェブフック設定に関する情報。

is_enabledboolean必須

ゲームサービスのウェブフックが有効かどうか。

ゲームサービス のウェブフックの場合、このAPIコールで指定された設定は、プロジェクト設定 > ウェブフックセクションのパブリッシャーアカウントで構成された設定よりも優先されます。

例: true
secretstring必須

ゲームサービスのウェブフックに署名するためのプロジェクトの秘密鍵です。

ゲームサービスでは、このAPIコールで指定された鍵が、プロジェクト設定 > ウェブフックセクションのパブリッシャーアカウントで生成された鍵よりも優先されます。

例: "my_secret_key"
urlstring必須

ゲームサービスのウェブフックを受信するためのサーバーのURL。URL は一般にアクセス可能で、HTTPS プロトコル (https://example.comなど) を使用する必要があります。また、ウェブフックをテストするためのツールで見つけたURLを指定することもできます。

ゲームサービスのウェブフックでは、このAPIコールで指定された設定が、プロジェクト設定 > ウェブフックセクションのパブリッシャーアカウントで構成された設定よりも優先されます。

例: "http://site.ru/webhook"
versioninteger

ウェブフックのバージョン。バージョン2では、アイテム配列には、バージョン1(デフォルト)には存在しないパラメータis_freeis_bonus、およびis_bundle_contentが含まれています。

列挙型12
例: 1
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
  }'

レスポンス

ウェブフック設定に関する情報がは常に更新されました。

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

マーチャント

操作

カタログ

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

操作
操作
操作