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

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/

管理者

操作

カタログ

操作

仮想決済

操作

カタログ

操作

資格

操作

管理者

操作

コードを取得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/catalog/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

IDによるコードをアップロードServer-sideAdmin

リクエスト

ゲームキーIDによるコードをアップロードします。

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

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

例: 44056
item_idstring必須

アイテムID。

例: 656
ボディmultipart/form-data
filestring(binary)必須

コードを含むファイル。

例: "keys.txt"
region_idinteger

リージョンID。

例: 1
curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ja/api/catalog/v2/project/44056/admin/items/game/key/upload/id/656 \
  -H 'Content-Type: multipart/form-data' \
  -F file=keys.txt \
  -F region_id=1

レスポンス

セッション情報を読み込むコードが正常に受信されました。

ボディapplication/json
count_skippedinteger
例: 10
count_totalinteger
例: 100
count_uploadedinteger
例: 0
session_idstring
例: "fc7105b6e8ee01339582970b37697242"
statusstring
例: "processing"
レスポンス
application/json
{
  "count_skipped": 10,
  "count_total": 100,
  "count_uploaded": 0,
  "session_id": "fc7105b6e8ee01339582970b37697242",
  "status": "processing"
}

コード読み込みセッションに関する情報を取得Server-sideAdmin

リクエスト

コード読み込みセッションに関する情報を取得します。

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

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

例: 44056
session_idstring必須

セッションID。

デフォルト "fc7105b6e8ee01339582970b37697242"
curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ja/api/catalog/v2/project/44056/admin/items/game/key/upload/session/{session_id}'

レスポンス

セッション情報を読み込むコードが正常に受信されました。

ボディapplication/json
count_skippedinteger
例: 10
count_totalinteger
例: 100
count_uploadedinteger
例: 0
session_idstring
例: "fc7105b6e8ee01339582970b37697242"
statusstring
例: "processing"
レスポンス
application/json
{
  "count_skipped": 10,
  "count_total": 100,
  "count_uploaded": 0,
  "session_id": "fc7105b6e8ee01339582970b37697242",
  "status": "processing"
}

管理者

操作

カタログ

操作

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

操作

カート（サーバー側）

操作

決済（クライアント側）

操作

決済（サーバー側）

操作

注文

操作

無料アイテム

操作

管理

操作

管理者

操作

ウェブフック

操作

先行予約

操作

マーチャント

操作

カタログ

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

操作

共通地域

操作

管理者

操作