コンテンツへスキップ

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/
操作
操作
操作
操作
操作
操作
操作

指定されたグループexternal IDのバンドルリストを取得するServer-sideAdmin

リクエスト

管理用のグループ内のバンドルリストを取得します。



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

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

例: 44056
external_idstring必須

グループexternal ID。

デフォルト "all"
クエリ
limitinteger>= 1

ページでの要素数の制限。

例: limit=50
offsetinteger>= 0

リストが生成される要素番号(カウントは0から始まります)。

例: offset=0
curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ja/api/catalog/v2/project/44056/admin/items/bundle/group/external_id/{external_id}?limit=50&offset=0'

レスポンス

バンドルのリストは正常に受信されました。

ボディapplication/json
itemsArray of objects(Bundles_admin_bundle_response)
レスポンス
application/json
{ "items": [ {}, {} ] }

指定されたグループIDのバンドルリストを取得するServer-sideAdmin

リクエスト

管理用のグループ内のバンドルリストを取得します。



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

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

例: 44056
group_idinteger必須

グループID。

例: 10
クエリ
limitinteger>= 1

ページでの要素数の制限。

例: limit=50
offsetinteger>= 0

リストが生成される要素番号(カウントは0から始まります)。

例: offset=0
curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ja/api/catalog/v2/project/44056/admin/items/bundle/group/id/10?limit=50&offset=0'

レスポンス

バンドルのリストは正常に受信されました。

ボディapplication/json
itemsArray of objects(Bundles_admin_bundle_response)
レスポンス
application/json
{ "items": [ {}, {} ] }

バンドルを削除Server-sideAdmin

リクエスト

バンドルを削除します。

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

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

例: 44056
skustring必須

バンドルSKU。

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

レスポンス

バンドルは正常に削除されました。

ボディ
レスポンス
コンテンツなし
操作

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

操作

カート(サーバー側)

操作

決済(クライアント側)

操作

決済(サーバー側)

操作
操作

無料アイテム

操作
操作
操作

ウェブフック

操作
操作

マーチャント

操作

カタログ

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

操作
操作
操作