コンテンツへスキップ

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記述をダウンロード
index.json
index.yaml
言語
サーバー
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プロパティに渡します。

操作

管理者

操作

カタログ

操作

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

操作

カート（サーバー側）

操作

決済（クライアント側）

操作

決済（サーバー側）

操作

注文

操作

無料アイテム

操作

ウェブフック

操作

ウェブフック設定に関する情報を取得Server-sideAdmin

リクエスト

ストアのウェブフック設定に関する情報を取得します。 詳しくは、ウェブフックのドキュメントをご覧ください。

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

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

例: 44056
curl -i -X GET \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ja/api/shop-builder/v2/project/44056/admin/webhook

レスポンス

ウェブフック設定に関する情報は正常に受信されました。

ボディapplication/json
is_enabledboolean
例: true
secretstring
例: "my_secret"
urlstring
例: "http://site.ru/webhook"
レスポンス
application/json
{
  "is_enabled": true,
  "secret": "my_secret",
  "url": "http://site.ru/webhook"
}

ウェブフック設定に関する情報を更新Server-sideAdmin

リクエスト

ストアのウェブフック設定に関する情報を更新します。 詳しくは、ウェブフックのドキュメントをご覧ください。

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

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

例: 44056
ボディapplication/json必須

ウェブフック設定に関する情報。

is_enabledboolean必須

ゲームサービスのウェブフックが有効かどうか。

ゲームサービス のウェブフックの場合、このAPIコールで指定された設定は、プロジェクト設定 > ウェブフックセクションのパブリッシャーアカウントで構成された設定よりも優先されます。

例: true
secretstring必須

ゲームサービスのウェブフックに署名するためのプロジェクトの秘密鍵です。

ゲームサービスでは、このAPIコールで指定された鍵が、プロジェクト設定 > ウェブフックセクションのパブリッシャーアカウントで生成された鍵よりも優先されます。

例: "my_secret_key"
urlstring必須

ゲームサービスのウェブフックを受信するためのサーバーのURL。URL は一般にアクセス可能で、HTTPS プロトコル (https://example.comなど) を使用する必要があります。また、ウェブフックをテストするためのツールで見つけたURLを指定することもできます。

ゲームサービスのウェブフックでは、このAPIコールで指定された設定が、プロジェクト設定 > ウェブフックセクションのパブリッシャーアカウントで構成された設定よりも優先されます。

例: "http://site.ru/webhook"
versioninteger

ウェブフックのバージョン。バージョン2では、アイテム配列には、バージョン1（デフォルト）には存在しないパラメータis_free、is_bonus、およびis_bundle_contentが含まれています。

列挙型12
例: 1
curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ja/api/shop-builder/v2/project/44056/admin/webhook \
  -H 'Content-Type: application/json' \
  -d '{
    "is_enabled": true,
    "secret": "my_secret_key",
    "url": "http://site.ru/webhook",
    "version": 1
  }'

レスポンス

ウェブフック設定に関する情報がは常に更新されました。

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

先行予約

操作

マーチャント

操作

カタログ

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

操作

共通地域

操作

カタログ

操作

資格

操作

管理者

操作

通常

操作

クーポン

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

操作

プロモーションコード

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

操作

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

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

操作

ディスカウント

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

操作

ボーナス

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

操作

管理者

操作

カタログ

操作

仮想決済

操作

管理

操作

管理者

操作

クライアント

操作

クランクライアント

操作

管理者

操作

クライアント

操作

管理者

操作

クライアント

操作

管理者

操作

クライアント

操作

管理者

操作