コンテンツへスキップ

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プロパティに渡します。

操作
操作
操作

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

操作

カート(サーバー側)

操作

決済(クライアント側)

操作

決済(サーバー側)

操作
操作

無料アイテム

操作

ウェブフック

操作
操作

マーチャント

操作

カタログ

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

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

クーポン

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

操作

プロモーションコード

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

操作

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

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

操作

ディスカウント

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

操作

ボーナス

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

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

クライアント

操作

クランクライアント

操作
操作

クライアント

操作

無料オファーチェーンステップを請求するClient-side

リクエスト

現在のユーザーのオファーチェーンステップの進行を完了させ、関連する報酬を付与します。

注意

このコールは、オファーチェーン内の無料ステップにのみ使用してください。 実際通貨での支払いが必要なステップには、代わりに有料オファーチェーンステップの注文を作成するコールを使用してください。
セキュリティ
XsollaLoginUserJWT
パス
project_idinteger必須

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

例: 44056
offer_chain_idinteger必須

オファーチェーンID。

例: 101
step_numberinteger必須

オファーチェーンステップ番号。

例: 1
curl -i -X POST \
  https://xsolla.redocly.app/_mock/ja/api/shop-builder/v2/project/44056/user/offer_chain/101/step/number/1/claim \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

レスポンス

無料ステップが正常に請求され、報酬が付与されました。

ボディapplication/json
order_idinteger

注文ID。

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

有料のオファーチェーンステップの注文を作成するClient-side

リクエスト

指定された有料オファーチェーンステップに関連付けられたアイテムの注文を作成します。作成された注文はnewの注文ステータスになります。

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

テスト目的の場合は、次のURLを使用してください:https://sandbox-secure.xsolla.com/paystation4/?token={token}

注意

このメソッドはクライアントサイドで使用する必要があります。ユーザーのIPアドレスは国を特定するために使用され、それが通貨や利用可能な決済方法に影響を与えます。このメソッドをサーバーサイドから使用すると、通貨の検出が不正確になり、ペイステーションでの決済方法に影響を与える可能性があります。

注意

有料のオファーチェーンステップにのみ、この呼び出しを使用してください。 無料ステップの場合は、代わりに無料オファーチェーンステップを請求するコールを使用してください。
セキュリティ
XsollaLoginUserJWT
パス
project_idinteger必須

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

例: 44056
offer_chain_idinteger必須

オファーチェーンID。

例: 101
step_numberinteger必須

オファーチェーンステップ番号。

例: 1
curl -i -X POST \
  https://xsolla.redocly.app/_mock/ja/api/shop-builder/v2/project/44056/user/offer_chain/101/step/number/1/order \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

レスポンス

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

ボディapplication/json
order_idinteger

注文ID。

tokenstring

決済トークン。

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

クライアント

操作
操作

クライアント

操作
操作