コンテンツへスキップ

Shop Builder 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

Shop Builder API provides a third-party solution for implementing the server side for your store interface. Use the endpoints to manage in-game items, in-game currencies, cart, player inventory, promotions, game library, etc.

OpenAPI記述をダウンロード
言語
サーバー
Mock server
https://xsolla.redocly.app/_mock/ja/api/shop-builder/
https://store.xsolla.com/api/
操作

個人用カタログ

ユーザー属性に応じたルールを指定することができるAPIです。 ユーザーが具体的なルールの条件をすべて満たした場合、パーソナライズされたアイテムが表示されます。

パーソナライズされたプロモーションについては、プロモーションセクションを参照してください。

購入前に属性を渡すには、Xsolla Login APIを使うか、Pay Station APIを使ってトークンを生成する際にそれをuser.attributesプロパティに渡します。

操作
操作
操作

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

操作

カート(サーバー側)

操作

決済(クライアント側)

操作

現在のカートの全アイテムを対象とした注文を作成するClient-side

リクエスト

クライアントサーバーへの統合に使用されます。カートからのすべてのアイテムを含む注文を作成し、そのための決済トークンを生成します。作成された注文はnew注文ステータスを取得します。

クライアントIPは、ユーザーの国を決定するために使用され、注文に対応する通貨と利用可能な決済方法を適用するために使用されます。

決済UIを新しいウィンドウで開くには、以下のリンクをご利用ください:https://secure.xsolla.com/paystation4/?token={token}{token}受信したトークン。

テスト目的には、以下のリンクを使用してください:https://sandbox-secure.xsolla.com/paystation4/?token={token}

注意

このメソッドはIPを使用してユーザーの国を決定し、注文の通貨を選択するため、このメソッドはクライアント側からのみ使用し、サーバー側からは使用しないことが重要です。サーバー側からこの方法を使用すると、通貨が正しく判定されず、ペイステーションの決済方法に影響を与える可能性があります。
セキュリティ
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/shop-builder/v2/project/44056/payment/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。

tokenstring

決済トークン。

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

特定のカートの全アイテムを対象とした注文を作成するClient-side

リクエスト

クライアントサーバーへの統合に使用されます。特定のカートからのすべてのアイテムを含む注文を作成し、そのための決済トークンを生成します。作成された注文はnew注文ステータスを取得します。

クライアントIPは、ユーザーの国を決定するために使用され、注文に対応する通貨と利用可能な決済方法を適用するために使用されます。

決済UIを新しいウィンドウで開くには、以下のリンクをご利用ください:https://secure.xsolla.com/paystation4/?token={token}{token}受信したトークン。

テスト目的には、以下のリンクを使用してください:https://sandbox-secure.xsolla.com/paystation4/?token={token}

注意

このメソッドはIPを使用してユーザーの国を決定し、注文の通貨を選択するため、このメソッドはクライアント側からのみ使用し、サーバー側からは使用しないことが重要です。サーバー側からこの方法を使用すると、通貨が正しく判定されず、ペイステーションの決済方法に影響を与える可能性があります。
セキュリティ
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/shop-builder/v2/project/44056/payment/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。

tokenstring

決済トークン。

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

指定したアイテムで注文を作成するClient-side

リクエスト

クライアントサーバーへの統合に使用されます。指定されたアイテムの注文を作成し、そのアイテムに対する決済トークンを生成します。作成された注文はnew注文ステータスを取得します。

クライアントIPは、ユーザーの国を決定するために使用され、注文に対応する通貨と利用可能な決済方法を適用するために使用されます。

決済UIを新しいウィンドウで開くには、以下のリンクをご利用ください:https://secure.xsolla.com/paystation4/?token={token}{token}受信したトークン。

テスト目的には、以下のリンクを使用してください:https://sandbox-secure.xsolla.com/paystation4/?token={token}

注意

このメソッドはIPを使用してユーザーの国を決定し、注文の通貨を選択するため、このメソッドはクライアント側からのみ使用し、サーバー側からは使用しないことが重要です。サーバー側からこの方法を使用すると、通貨が正しく判定されず、ペイステーションの決済方法に影響を与える可能性があります。
セキュリティ
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/shop-builder/v2/project/44056/payment/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。

tokenstring

決済トークン。

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

決済(サーバー側)

操作
操作

無料アイテム

操作

ウェブフック

操作
操作

マーチャント

操作

カタログ

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

操作
操作
操作
操作
操作
操作

クーポン

このAPIを使用すると、クーポンを管理できます。

操作

プロモーションコード

このAPI を使用すると、プロモーションコードを管理できます。

操作

ユニークなカタログオファー

このAPIを使用すると、ユニークなカタログオファーを管理することができます。

操作

ディスカウント

このAPIを使用すると、割引キャンペーンを管理することができます。

操作

ボーナス

このAPIを使用すると、ボーナスプロモーションを管理できます。

操作
操作
操作
操作
操作
操作

クライアント

操作

クランクライアント

操作
操作

クライアント

操作
操作

クライアント

操作
操作

クライアント

操作
操作