コンテンツへスキップ

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/

管理者

操作

カタログ

操作

仮想決済

操作

カタログ

操作

資格

操作

管理者

操作

管理者

操作

カタログ

操作

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

操作

カート（サーバー側）

操作

決済（クライアント側）

操作

決済（サーバー側）

操作

注文

操作

無料アイテム

操作

無料カートで注文を作成するClient-side

リクエスト

無料カートのすべてのアイテムを含む注文を作成します。作成された注文はdoneという注文状況を取得します。

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

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

例: 44056
ボディapplication/json
currencystring

注文価格の通貨。3文字の通貨コードISO4217 規格詳細については、ドキュメントを参照してください。エクソーラでサポートされている通貨。

custom_parametersobject[ 1 .. 200 ] properties

プロジェクト特有のパラメータ。

localestring

応答言語。

sandboxboolean

サンドボックスモードで注文を作成します。このオプションは、会社のユーザーリストに指定されているユーザーに使用できます。

デフォルト false
settingsobject

ユーザーの支払いプロセスと決済UIを構成するための設定。

curl -i -X POST \
  https://xsolla.redocly.app/_mock/ja/api/catalog/v2/project/44056/free/cart \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "custom_parameters": {
      "character_id": "ingameUsername"
    },
    "sandbox": true,
    "settings": {
      "ui": {
        "desktop": {
          "header": {
            "close_button": false,
            "is_visible": true,
            "type": "normal",
            "visible_logo": true,
            "visible_name": true,
            "visible_purchase": true
          }
        },
        "theme": "63295a9a2e47fab76f7708e1"
      }
    }
  }'

レスポンス

無料注文が正常に作成されました。

ボディapplication/json
order_idinteger

注文ID。

レスポンス
application/json
{
  "order_id": 641
}

特定の無料カートで注文を作成するClient-side

リクエスト

特定の無料カートのすべてのアイテムを含む注文を作成します。作成された注文はdoneという注文状況を取得します。

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

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

例: 44056
cart_idstring必須

カートID。

例: custom_id
ボディapplication/json
currencystring

注文価格の通貨。3文字の通貨コードISO4217 規格詳細については、ドキュメントを参照してください。エクソーラでサポートされている通貨。

custom_parametersobject[ 1 .. 200 ] properties

プロジェクト特有のパラメータ。

localestring

応答言語。

sandboxboolean

サンドボックスモードで注文を作成します。このオプションは、会社のユーザーリストに指定されているユーザーに使用できます。

デフォルト false
settingsobject

ユーザーの支払いプロセスと決済UIを構成するための設定。

curl -i -X POST \
  https://xsolla.redocly.app/_mock/ja/api/catalog/v2/project/44056/free/cart/custom_id \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "custom_parameters": {
      "character_id": "ingameUsername"
    },
    "sandbox": true,
    "settings": {
      "ui": {
        "desktop": {
          "header": {
            "close_button": false,
            "is_visible": true,
            "type": "normal",
            "visible_logo": true,
            "visible_name": true,
            "visible_purchase": true
          }
        },
        "theme": "63295a9a2e47fab76f7708e1"
      }
    }
  }'

レスポンス

無料注文が正常に作成されました。

ボディapplication/json
order_idinteger

注文ID。

レスポンス
application/json
{
  "order_id": 641
}

指定された無料アイテムで注文を作成するClient-side

リクエスト

指定された無料アイテムで注文を作成します。作成された注文は doneという注文状況を取得します。

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

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

例: 44056
item_skustring必須

アイテムSKU。

例: booster_mega_1
ボディapplication/json
currencystring

注文価格の通貨。3文字の通貨コードISO4217 規格詳細については、ドキュメントを参照してください。エクソーラでサポートされている通貨。

custom_parametersobject[ 1 .. 200 ] properties

プロジェクト特有のパラメータ。

localestring

応答言語。

promo_codestring

支払いによりプロモーションコードキャンペーンのコードを引き換えます。

quantityinteger>= 1

アイテム数量。

デフォルト 1
sandboxboolean

サンドボックスモードで注文を作成します。このオプションは、会社のユーザーリストに指定されているユーザーに使用できます。

デフォルト false
settingsobject

ユーザーの支払いプロセスと決済UIを構成するための設定。

curl -i -X POST \
  https://xsolla.redocly.app/_mock/ja/api/catalog/v2/project/44056/free/item/booster_mega_1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "custom_parameters": {
      "character_id": "ingameUsername"
    },
    "promo_code": "discount_code",
    "quantity": 5,
    "sandbox": true,
    "settings": {
      "ui": {
        "desktop": {
          "header": {
            "close_button": false,
            "is_visible": true,
            "type": "normal",
            "visible_logo": true,
            "visible_name": true,
            "visible_purchase": true
          }
        },
        "theme": "63295a9a2e47fab76f7708e1"
      }
    }
  }'

レスポンス

無料注文が正常に作成されました。

ボディapplication/json
order_idinteger

注文ID。

レスポンス
application/json
{
  "order_id": 641
}

管理

操作

管理者

操作

ウェブフック

操作

先行予約

操作

マーチャント

操作

カタログ

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

操作

共通地域

操作

管理者

操作