コンテンツへスキップ

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記述をダウンロード
index.json
index.yaml
言語
サーバー
Mock server
https://xsolla.redocly.app/_mock/ja/api/catalog/
https://store.xsolla.com/api/

管理者

操作

カタログ

操作

仮想決済

操作

カタログ

操作

資格

操作

資格付与（管理者）Server-sideAdmin

リクエスト

ユーザーに権利を付与します。

注意

ゲームコードやDRM-freeプラットフォームのゲームのみ付与可能です。
セキュリティ
basicAuth
パス
project_idinteger必須

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

例: 44056
ボディapplication/json必須
codestring or null

ゲームのゲームコード。

例: "AAAA-BBBB-CCCC-DDDD"
drmobject必須

DRMプロパティを持つオブジェクト。

例: {"sku":"com.xsolla.key_1"}
drm.​skustring(Game-Keys_drm_sku)必須

一意のDRM ID。

列挙型"steam""playstation""xbox""uplay""origin""drmfree""gog""epicgames""nintendo_eshop""discord_game_store"
例: "steam"
gameobject必須

ゲームプロパティを持つオブジェクト。

例: {"sku":"com.xsolla.game_1"}
game.​skustring(Game-Keys_game_sku)[ 1 .. 255 ] characters^[a-zA-Z0-9_\-–.]*$必須

一意のキーパッケージID。

例: "theGreatestGameSku"
modestring必須

どのような種類の資格を付与するかを指定します。このパラメータがsandboxに設定されている場合、サンドボックスモードのユーザーにエンタイトルメントが付与されます。パラメータにdefaultが設定されている場合、エンタイトルメントはライブモードでユーザーに付与されます。

列挙型"default""sandbox"
例: "default"
user_countrystring or null

ユーザーの国。

例: "US"
user_external_idstring必須

一意のユーザー識別子。

例: "user-external-id"
curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ja/api/catalog/v2/project/44056/admin/entitlement/grant \
  -H 'Content-Type: application/json' \
  -d '{
    "code": "AAAA-BBBB-CCCC-DDDD",
    "drm": {
      "sku": "com.xsolla.key_1"
    },
    "game": {
      "sku": "com.xsolla.game_1"
    },
    "mode": "default",
    "user_country": "US",
    "user_external_id": "user-external-id"
  }'

レスポンス

資格が付与されました。

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

資格の取り消し（管理者）Server-sideAdmin

リクエスト

ユーザーの権利を取り消します。

注意

ゲームコードやDRMフリープラットフォームのゲームのみ取り消すことができます。
セキュリティ
basicAuth
パス
project_idinteger必須

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

例: 44056
ボディapplication/json必須
drmobject必須

DRMプロパティを持つオブジェクト。

例: {"sku":"com.xsolla.key_1"}
drm.​skustring(Game-Keys_drm_sku)必須

一意のDRM ID。

列挙型"steam""playstation""xbox""uplay""origin""drmfree""gog""epicgames""nintendo_eshop""discord_game_store"
例: "steam"
gameobject必須

ゲームプロパティを持つオブジェクト。

例: {"sku":"com.xsolla.game_1"}
game.​skustring(Game-Keys_game_sku)[ 1 .. 255 ] characters^[a-zA-Z0-9_\-–.]*$必須

一意のキーパッケージID。

例: "theGreatestGameSku"
modestring必須

どのような種類の資格を取り消すかを指定します。このパラメータがsandboxに設定されている場合、サンドボックスモードのユーザーにエンタイトルメントが取り消されます。パラメータにdefaultが設定されている場合、エンタイトルメントはライブモードでユーザーに取り消されます。

列挙型"default""sandbox"
例: "default"
user_external_idstring必須

一意のユーザー識別子。

例: "user-external-id"
curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ja/api/catalog/v2/project/44056/admin/entitlement/revoke \
  -H 'Content-Type: application/json' \
  -d '{
    "drm": {
      "sku": "com.xsolla.key_1"
    },
    "game": {
      "sku": "com.xsolla.game_1"
    },
    "mode": "default",
    "user_external_id": "user-external-id"
  }'

レスポンス

取り消しが成功しました。

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

ユーザーが所有しているゲームソフトのリストを取得Client-side

リクエスト

ユーザーが所有しているゲームソフトのリストを取得します。レスポンスには特定のユーザーが所有するゲームの配列が含まれます。

注意

すべてのプロジェクトには、応答で得られるアイテムの数に制限があります。初期値および最大値は、1応答あたり50アイテムです。ページごとにより多くのデータを取得するには、LIMITとOFFSETフィールドを使用してください。
セキュリティ
XsollaLoginUserJWT
パス
project_idinteger必須

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

例: 44056
クエリ
limitinteger>= 1

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

例: limit=50
offsetinteger>= 0

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

例: offset=0
sandboxinteger

どのような種類の資格が返されるべきか。このパラメータが1に設定された場合、サンドボックスモードでユーザーによって受信された資格のみが返されます。パラメータが渡されないまたは0に設定されている場合、ライブモードでのみユーザーによって受信された資格が返されます。

デフォルト 0
additional_fields[]Array of strings

追加フィールドのリスト。これらのフィールドは、リクエストの中で送信すると、応答に含まれます。利用可能なフィールドはattributes。

curl -i -X GET \
  'https://xsolla.redocly.app/_mock/ja/api/catalog/v2/project/44056/entitlement?limit=50&offset=0&sandbox=0&additional_fields%5B%5D=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

レスポンス

ユーザーが所有するゲームキーのリストが正常に受信しました。

ボディapplication/json
has_moreboolean(Pagination_has-more)

ページ数がもっとあることを示す指標として使用されます。

例: true
itemsArray of objects(Game-Keys_entitlement_item)
total_items_countinteger(Pagination_total-items-count)

システムでのアイテムの合計数。

例: 10
レスポンス
application/json
{
  "has_more": false,
  "items": [
    { … }
  ],
  "total_items_count": 1
}

管理者

操作

管理者

操作

カタログ

操作

カート（クライアント側）

操作

カート（サーバー側）

操作

決済（クライアント側）

操作

決済（サーバー側）

操作

注文

操作

無料アイテム

操作

管理

操作

管理者

操作

ウェブフック

操作

先行予約

操作

マーチャント

操作

カタログ

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

操作

共通地域

操作

管理者

操作