コンテンツへスキップ

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

リクエスト

属性のすべての値を削除します。

注意

属性の値を削除すると、その属性とアイテム間のすべての関連付けが失われます。アイテムの属性値を変更するには、値を削除して新しい値を作成するのではなく、属性値を更新するAPIコールを使用してください。
セキュリティ
basicAuth
パス
project_idinteger必須

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

例: 44056
external_idstring必須

属性external ID。

例: attribute_id
curl -i -X DELETE \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/attribute/attribute_id/value

レスポンス

属性値が正常に削除されました。

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

属性値を作成Server-sideAdmin

リクエスト

属性値を作成します。

注意

すべてのプロジェクトには、応答で得られる属性値に制限があります。初期値および最大値は、1属性あたり20個の値。
セキュリティ
basicAuth
パス
project_idinteger必須

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

例: 44056
external_idstring必須

属性external ID。

例: attribute_id
ボディapplication/json
external_idstring(value-external_id)[ 1 .. 255 ] characters^[-_.\d\w]+$必須

属性の一意の値ID。external_idには、英小文字、ダッシュ、およびアンダースコアのみが含まれます。

例: "attribute_value"
valueobject(value-name)必須

値名がローカライズされたオブジェクト。キーはISO 3166-1で指定されています。

デフォルト {"de":"Strategie","en":"Strategy"}
例: {"de":"Strategie","en":"Strategy"}
value.​property name*string追加プロパティ
curl -i -X POST \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/attribute/attribute_id/value \
  -H 'Content-Type: application/json' \
  -d '{
    "external_id": "weapon_class_sword_value",
    "value": {
      "de": "Schwert",
      "en": "Sword"
    }
  }'

レスポンス

属性値は正常に作成されました。

ボディapplication/json
external_idstring(value-external_id)[ 1 .. 255 ] characters^[-_.\d\w]+$

属性の一意の値ID。external_idには、英小文字、ダッシュ、およびアンダースコアのみが含まれます。

例: "attribute_value"
レスポンス
application/json
{ "external_id": "rpg" }

属性値を削除Server-sideAdmin

リクエスト

一つの属性値を削除します。

注意

属性の値を削除すると、その属性とアイテム間のすべての関連付けが失われます。アイテムの属性値を変更するには、値を削除して新しい値を作成するのではなく、属性値を更新するAPIコールを使用してください。
セキュリティ
basicAuth
パス
project_idinteger必須

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

例: 44056
value_external_idstring^[-_\.\d\w]+$必須

属性値のexternal ID。

例: value_id
external_idstring必須

属性external ID。

例: attribute_id
curl -i -X DELETE \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/attribute/attribute_id/value/value_id

レスポンス

属性値が正常に削除されました。

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