コンテンツへスキップ
/
IDによるコードを取得

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

操作

管理者

操作

カタログ

操作

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

操作

カート（サーバー側）

操作

決済（クライアント側）

操作

決済（サーバー側）

操作

注文

操作

無料アイテム

操作

ウェブフック

操作

先行予約

操作

マーチャント

操作

カタログ

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

操作

共通地域

操作

カタログ

操作

資格

操作

管理者

操作

コードを削除Server-sideAdmin

リクエスト

ゲームキーSKUによる全コードを削除します。

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

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

例: 44056
item_skustring必須

アイテムSKU。

例: booster_mega_1
クエリ
user_emailstring必須

ユーザーのメールアドレス。

例: user_email=email@email.com
reasonstring必須

コード受信の理由。

例: reason=Very important
region_idinteger

リージョンID。

デフォルト 1
curl -i -X DELETE \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ja/api/shop-builder/v2/project/44056/admin/items/game/key/delete/sku/booster_mega_1?user_email=email%40email.com&reason=Very+important&region_id=1'

レスポンス

コードは正常に受信されました。

ボディtext/plain
string
レスポンス
text/plain
PIN-CODE-ALL PIN-CODE-ALL-3

IDによるコードを取得Server-sideAdmin

リクエスト

ゲームキーIDによる一定数のコードを取得します。

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

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

例: 44056
item_idstring必須

アイテムID。

例: 656
クエリ
user_emailstring必須

ユーザーのメールアドレス。

例: user_email=email@email.com
quantityinteger必須

コード数量。

例: quantity=100
reasonstring必須

コード受信の理由。

例: reason=Very important
region_idinteger

リージョンID。

デフォルト 1
curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ja/api/shop-builder/v2/project/44056/admin/items/game/key/request/id/656?user_email=email%40email.com&quantity=100&reason=Very+important&region_id=1'

レスポンス

コードは正常に受信されました。

ボディtext/plain
string
レスポンス
text/plain
PIN-CODE-ALL PIN-CODE-ALL-3

コードを取得Server-sideAdmin

リクエスト

ゲームキーSKUによる一定数のコードを取得します。

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

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

例: 44056
item_skustring必須

アイテムSKU。

例: booster_mega_1
クエリ
user_emailstring必須

ユーザーのメールアドレス。

例: user_email=email@email.com
quantityinteger必須

コード数量。

例: quantity=100
reasonstring必須

コード受信の理由。

例: reason=Very important
region_idinteger

リージョンID。

デフォルト 1
curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ja/api/shop-builder/v2/project/44056/admin/items/game/key/request/sku/booster_mega_1?user_email=email%40email.com&quantity=100&reason=Very+important&region_id=1'

レスポンス

コードは正常に受信されました。

ボディtext/plain
string
レスポンス
text/plain
PIN-CODE-ALL PIN-CODE-ALL-3

通常

操作

クーポン

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

操作

プロモーションコード

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

操作

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

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

操作

ディスカウント

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

操作

ボーナス

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

操作

管理者

操作

カタログ

操作

仮想決済

操作

管理

操作

管理者

操作

クライアント

操作

クランクライアント

操作

管理者

操作

クライアント

操作

管理者

操作

クライアント

操作

管理者

操作

クライアント

操作

管理者

操作