コンテンツへスキップ

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記述をダウンロード
言語
サーバー
Mock server
https://xsolla.redocly.app/_mock/ja/api/catalog/
https://store.xsolla.com/api/
操作
操作
操作
操作
操作
操作
操作
操作

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

操作

カート(サーバー側)

操作

決済(クライアント側)

操作

決済(サーバー側)

操作
操作

無料アイテム

操作
操作
操作

ウェブフック

操作
操作

マーチャント

操作

カタログ

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

操作
操作
操作

属性を削除Server-sideAdmin

リクエスト

属性を削除します。

注意

アイテム属性を削除すると、そのすべてのデータおよびアイテムとの関連付けが失われます。
セキュリティ
basicAuth
パス
project_idinteger必須

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

例: 44056
external_idstring必須

属性external ID。

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

レスポンス

属性が正常に削除されました。

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

指定された属性を取得Server-sideAdmin

リクエスト

指定された属性を取得します。

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

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

例: 44056
external_idstring必須

属性external ID。

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

レスポンス

指定された属性は正常に受信されました。

ボディapplication/json
external_idstring(admin-attribute-external_id)[ 1 .. 255 ] characters^[a-zA-Z0-9-_]+$

一意の属性ID。external_idには、小文字と大文字のラテン英数字、ダッシュ、およびアンダースコアのみが含まれます。

例: "attribute_1"
nameobject(admin-attribute-name)

属性用のローカライズされたオブジェクト。キーはISO 3166-1で指定されています。

デフォルト {"de":"Genre","en":"Genre"}
例: {"de":"Genre","en":"Genre"}
レスポンス
application/json
{ "value": [ {} ] }

属性を更新Server-sideAdmin

リクエスト

属性を更新します。

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

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

例: 44056
external_idstring必須

属性external ID。

例: attribute_id
ボディapplication/json
external_idstring(admin-attribute-external_id)[ 1 .. 255 ] characters^[a-zA-Z0-9-_]+$必須

一意の属性ID。external_idには、小文字と大文字のラテン英数字、ダッシュ、およびアンダースコアのみが含まれます。

例: "attribute_1"
nameobject(admin-attribute-name)必須

属性用のローカライズされたオブジェクト。キーはISO 3166-1で指定されています。

デフォルト {"de":"Genre","en":"Genre"}
例: {"de":"Genre","en":"Genre"}
name.​property name*string追加プロパティ
curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ja/api/catalog/v2/project/44056/admin/attribute/attribute_id \
  -H 'Content-Type: application/json' \
  -d '{
    "external_id": "genre",
    "name": {
      "de": "Genre",
      "en": "Genre"
    }
  }'

レスポンス

属性は正常に更新されました。

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