コンテンツへスキップ
/
地域を削除する

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/

管理者

操作

カタログ

操作

仮想決済

操作

カタログ

操作

資格

操作

管理者

操作

管理者

操作

カタログ

操作

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

操作

カート（サーバー側）

操作

決済（クライアント側）

操作

決済（サーバー側）

操作

注文

操作

無料アイテム

操作

管理

操作

管理者

操作

ウェブフック

操作

先行予約

操作

マーチャント

操作

カタログ

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

操作

共通地域

操作

地域を作成するServer-sideAdmin

リクエスト

地域を作成します。

地域制限を管理するためにリージョンを使用することができます。

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

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

例: 44056
ボディapplication/json
countriesArray of strings(Regions_countries)必須

地域に追加する国のリスト。
ISO 3166-1 alpha-2に従った2文字の大文字の国名コード。 エクソーラがサポートする国の詳細情報については、ドキュメントを確認してください。
例：["JP", "CN", "VN"]

nameobject(Regions_name)必須

地域名。キーと値のペアを含む必要があります。キーは"^[a-z]{2}-[A-Z]{2}$"フォーマットのロケール、値は文字列です。

デフォルト {"de-DE":"Asien","en-US":"Asia"}
例: {"de-DE":"Asien","en-US":"Asia"}
name.​property name*string追加プロパティ
curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ja/api/catalog/v2/project/44056/admin/region \
  -H 'Content-Type: application/json' \
  -d '{
    "countries": [
      "JP",
      "CN",
      "VN"
    ],
    "name": {
      "de-DE": "Asien",
      "en-US": "Asia"
    }
  }'

レスポンス

地域が正常に作成されました。

ボディapplication/json
region_idinteger(Regions_region_id)

地域ID。プロジェクト内での一意の地域識別子。

例: 42
レスポンス
application/json
{
  "region_id": 42
}

地域を削除するServer-sideAdmin

リクエスト

特定の地域を削除します。

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

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

例: 44056
region_idinteger必須

地域ID。プロジェクト内での一意の地域識別子。

例: 42
curl -i -X DELETE \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ja/api/catalog/v2/project/44056/admin/region/42

レスポンス

地域は正常に削除されました。

ボディ
レスポンス
コンテンツなし

地域を取得するServer-sideAdmin

リクエスト

特定地域を取得します。

地域制限を管理するために地域を使用することができます。

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

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

例: 44056
region_idinteger必須

地域ID。プロジェクト内での一意の地域識別子。

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

レスポンス

指定された地域は正常に受信されました。

ボディapplication/json
countriesArray of strings(Regions_countries)

地域に追加する国のリスト。
ISO 3166-1 alpha-2に従った2文字の大文字の国名コード。 エクソーラがサポートする国の詳細情報については、ドキュメントを確認してください。
例：["JP", "CN", "VN"]

idinteger(Regions_region_id)

地域ID。プロジェクト内での一意の地域識別子。

例: 42
nameobject(Regions_name)

地域名。キーと値のペアを含む必要があります。キーは"^[a-z]{2}-[A-Z]{2}$"フォーマットのロケール、値は文字列です。

デフォルト {"de-DE":"Asien","en-US":"Asia"}
例: {"de-DE":"Asien","en-US":"Asia"}
レスポンス
application/json
{
  "value": {
    "countries": [ … ],
    "id": 44,
    "name": { … }
  }
}

管理者

操作