コンテンツへスキップ

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

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

操作

カート(サーバー側)

操作

決済(クライアント側)

操作

決済(サーバー側)

操作
操作

無料アイテム

操作
操作
操作

ウェブフック

操作
操作

マーチャント

操作

カタログ

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

操作
操作

地域を取得するServer-sideAdmin

リクエスト

特定地域を取得します。

地域制限を管理するために地域を使用することができます。

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

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

例: 44056
region_idinteger必須

地域ID。プロジェクト内での一意の地域識別子。

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

レスポンス

指定された地域は正常に受信されました。

ボディapplication/json
countriesArray of strings(Regions_countries)

地域に追加する国のリスト。
ISO 3166-1 alpha-2に従った2文字の大文字の国名コード。 エクソーラがサポートする国の詳細情報については、ドキュメントを確認してください。
例:["JP", "CN", "VN"]

idinteger(Regions_region_id)

地域ID。プロジェクト内での一意の地域識別子。

例: 42
nameobject(Regions_name)

地域名。キーと値のペアを含む必要があります。キーは"^[a-z]{2}-[A-Z]{2}$"フォーマットのロケール、値は文字列です。

デフォルト {"de-DE":"Asien","en-US":"Asia"}
例: {"de-DE":"Asien","en-US":"Asia"}
レスポンス
application/json
{ "value": { "countries": [], "id": 44, "name": {} } }

地域を更新するServer-sideAdmin

リクエスト

特定地域を更新します。

地域制限を管理するために地域を使用することができます。

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

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

例: 44056
region_idinteger必須

地域ID。プロジェクト内での一意の地域識別子。

例: 42
ボディapplication/json
countriesArray of strings(Regions_countries)必須

地域に追加する国のリスト。
ISO 3166-1 alpha-2に従った2文字の大文字の国名コード。 エクソーラがサポートする国の詳細情報については、ドキュメントを確認してください。
例:["JP", "CN", "VN"]

nameobject(Regions_name)必須

地域名。キーと値のペアを含む必要があります。キーは"^[a-z]{2}-[A-Z]{2}$"フォーマットのロケール、値は文字列です。

デフォルト {"de-DE":"Asien","en-US":"Asia"}
例: {"de-DE":"Asien","en-US":"Asia"}
name.​property name*string追加プロパティ
curl -i -X PUT \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/region/42 \
  -H 'Content-Type: application/json' \
  -d '{
    "countries": [
      "JP",
      "CN",
      "VN"
    ],
    "name": {
      "de-DE": "Asien",
      "en-US": "Asia"
    }
  }'

レスポンス

地域が正常に更新されました。

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