コンテンツへスキップ
/
プロモーションにキャンペーンを追加

Subscriptions API (2.0)

概要

  • Version: 2.0
  • Servers: https://api.xsolla.com/merchant/v2/

このAPIリファレンスでは、サブスクリプション、クーポン、およびプロモーションを管理するためのエンドポイントについて説明します。 サブスクリプションの詳細については、製品ガイドおよび用語集を参照してください。

OpenAPI記述をダウンロード
index.json
index.yaml
言語
サーバー
Mock server
https://xsolla.redocly.app/_mock/ja/api/subscriptions/

トークン

操作

プラン

操作

製品

操作

Subscription management

操作

決済

操作

プロモーション

操作

クーポン

操作

キャンペーンにクーポンを追加

リクエスト

クーポン キャンペーンにクーポン コードを追加します。

通知

APIコールにproject_idパスパラメータが含まれていないため、会社の全プロジェクトで有効なAPIキーを使用して認可を設定する必要があります。

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

マーチャントID。

campaign_idinteger必須

キャンペーンID。

ボディapplication/json必須
coupon_codestring必須

クーポンコード。

例: "34bryrb3"
curl -i -X POST \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ja/api/subscriptions/merchants/{merchant_id}/coupon_promotions/{campaign_id}/coupons' \
  -H 'Content-Type: application/json' \
  -d '{
    "coupon_code": "34bryrb3"
  }'

レスポンス

No Content (コンテンツなし) 。

プロモーションにキャンペーンを追加

リクエスト

特定のプロモーションにクーポン キャンペーンを添付します。

通知

APIコールにproject_idパスパラメータが含まれていないため、会社の全プロジェクトで有効なAPIキーを使用して認可を設定する必要があります。

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

マーチャントID。

promotion_idinteger必須

プロモーションID。

ボディapplication/json必須
campaignsArray of integers必須

キャンペーンIDの配列。

例: [9135]
curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ja/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}/coupons' \
  -H 'Content-Type: application/json' \
  -d '{
    "campaigns": [
      9135
    ]
  }'

レスポンス

No Content (コンテンツなし) 。

クーポンの取得

リクエスト

クーポンの詳細をコードで入手してください。

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

プロジェクトID。

codestring必須

クーポンコード。

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ja/api/subscriptions/projects/{project_id}/coupons/{code}/details'

レスポンス

OK。

ボディapplication/json
keystring

ユーザー属性のキー。

list_of_valuesArray of objects

type=enumの可能な値（配列）。

nameobject

ローカライズされた属性名。

skip_condition_on_nonexistent_keyboolean

キーが存在しない場合は条件をスキップするかどうかを示します。

typestring

キータイプ。

列挙型"int""string""enum""date"
visibleboolean
レスポンス
application/json
{
  "key": "12",
  "list_of_values": [],
  "name": {
    "en": "Level",
    "ru": "Уровень"
  },
  "skip_condition_on_nonexistent_key": true,
  "type": "int",
  "visible": false
}

Subscription management

操作