コンテンツへスキップ

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

リクエスト

ゲームキーSKUによる全コードを削除します。

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

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

例: 44056
item_skustring必須

アイテムSKU。

例: booster_mega_1
クエリ
user_emailstring必須

ユーザーのメールアドレス。

例: user_email=email@email.com
reasonstring必須

コード受信の理由。

例: reason=Very important
region_idinteger

リージョンID。

デフォルト 1
curl -i -X DELETE \
  -u <username>:<password> \
  'https://store.xsolla.com/api/v2/project/44056/admin/items/game/key/delete/sku/booster_mega_1?user_email=email%40email.com&reason=Very+important&region_id=1'

レスポンス

コードは正常に受信されました。

ボディtext/plain
string
レスポンス
text/plain
PIN-CODE-ALL PIN-CODE-ALL-3

IDによるコードを取得Server-sideAdmin

リクエスト

ゲームキーIDによる一定数のコードを取得します。

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

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

例: 44056
item_idstring必須

アイテムID。

例: 656
クエリ
user_emailstring必須

ユーザーのメールアドレス。

例: user_email=email@email.com
quantityinteger必須

コード数量。

例: quantity=100
reasonstring必須

コード受信の理由。

例: reason=Very important
region_idinteger

リージョンID。

デフォルト 1
curl -i -X GET \
  -u <username>:<password> \
  'https://store.xsolla.com/api/v2/project/44056/admin/items/game/key/request/id/656?user_email=email%40email.com&quantity=100&reason=Very+important&region_id=1'

レスポンス

コードは正常に受信されました。

ボディtext/plain
string
レスポンス
text/plain
PIN-CODE-ALL PIN-CODE-ALL-3

コードを取得Server-sideAdmin

リクエスト

ゲームキーSKUによる一定数のコードを取得します。

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

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

例: 44056
item_skustring必須

アイテムSKU。

例: booster_mega_1
クエリ
user_emailstring必須

ユーザーのメールアドレス。

例: user_email=email@email.com
quantityinteger必須

コード数量。

例: quantity=100
reasonstring必須

コード受信の理由。

例: reason=Very important
region_idinteger

リージョンID。

デフォルト 1
curl -i -X GET \
  -u <username>:<password> \
  'https://store.xsolla.com/api/v2/project/44056/admin/items/game/key/request/sku/booster_mega_1?user_email=email%40email.com&quantity=100&reason=Very+important&region_id=1'

レスポンス

コードは正常に受信されました。

ボディtext/plain
string
レスポンス
text/plain
PIN-CODE-ALL PIN-CODE-ALL-3
操作
操作

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

操作

カート(サーバー側)

操作

決済(クライアント側)

操作

決済(サーバー側)

操作
操作

無料アイテム

操作
操作
操作

ウェブフック

操作
操作

マーチャント

操作

カタログ

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

操作
操作
操作