サブスクリプション情報を取得する

ウェブショップでサブスクリプションを販売する場合は、次のいずれかの方法でサブスクリプションを使用したアクションに関する情報の受信を実装します:

APIコール経由のセットアップ

アプリケーションのクライアント側では、HTTP GETリクエストを利用してユーザーのサブスクリプション情報を取得することを実装します。

エクソラAPIはHTTPアクセス認証を使用します。リクエストはヘッダーAuthorization: Bearer <client_user_jwt>を含む必要があり、<client_user_jwt>はBase64標準に従ってエンコードされた一意のトークンです。それを取得するには:

パスパラメータprojectIdにプロジェクトIDを指定します。このパラメータは、パブリッシャーアカウントでプロジェクト名の横に表示されています。クエリパラメータとして指定します:

  • limit — ページ上の要素数の制限(デフォルトでは15個が表示されます)。
  • offset — リストが生成される要素の番号(カウントは0から始まる)。
  • locale — インターフェイスの言語(デフォルトは英語)。ISO 639-1規格に準拠した値を受け付けます。

Copy
Full screen
Small screen
リクエスト例:
  'https://subscriptions.xsolla.com​/api/user/v1/projects/{projectId}/subscriptions?locale=ru&limit=5&offset=5 ' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer client_user_jwt'

Copy
Full screen
Small screen
レスポンスの例:
{
  "items": [
    {
      "id": 13371337,
      "plan_id": 66053,
      "plan_external_id": "TestChangePlanBase",
      "plan_name": "package_recurrent_name_66053",
      "plan_description": "package_recurrent_description_66053",
      "product_id": null,
      "product_external_id": null,
      "product_name": null,
      "product_description": null,
      "status": "active",
      "date_create": "2021-03-11T13:50:11+03:00",
      "date_next_charge": "2031-04-11T13:51:02+03:00",
      "date_last_charge": "2021-03-11T13:51:02+03:00",
      "charge": {
        "amount": "0.2500",
        "currency": "USD"
      },
      "period": {
        "value": 5,
        "unit": "day"
      }
    }
  ],
  "has_more": true
}

ウェブフック経由のセットアップ

  1. ウェブフックを受信するためのパラメータを構成します:
    1. パブリッシャーアカウントでプロジェクトを開きます。
    2. サイドメニューのプロジェクト設定をクリックします。
    3. ウェブフックセクションに移動します。
    4. ウェブフックトグルをオンに設定します。
    5. ウェブフックURLフィールドで、ウェブフックを受信するURLを指定します。
    6. プロジェクトウェブフックにサインするための秘密鍵がデフォルトで生成されます。新しい秘密鍵を生成する場合は、更新アイコンをクリックします。
    7. 設定を保存するをクリックします。

  1. 以下の種類のウェブフックの処理をアプリケーションに実装してください。

  1. ウェブフックをテストします:
    1. パブリッシャーアカウント> プロジェクト設定 > ウェブフックで、サブスクリプションタブに移動します。

    1. ウェブフックをテストするには、プロジェクトの値(ユーザーID、インボイスID)を指定して、指定されたウェブフックURLへのリクエストで送信します。実際の値がない場合は、任意の値を入力することができます。次のフォームフィールドに入力します:
      • ユーザーID
      • エクソラインボイスID
      • 数量
      • 通貨
      • プランID
      • サブスクリプション製品(任意)
      • インボイスID — 内部注文番号(任意)
      • >試用期間( サンドボックスモードでサブスクリプションの支払いをテストするまたはサブスクリプションの更新をテストするには、0値を設定します。)

お知らせ
パブリッシャーアカウントでは、基本的なユーザー検証決済ウェブフックのみをテストできます。

    1. テストをクリックします。
    2. テストの成功メッセージを受信したことを確認します。テストが成功した場合、サーバーは次のように応答する必要があります:
      • メッセージ本文のないHTTPコード204。
      • 指定されたユーザーが見つからなかった場合、または無効な署名が渡された場合の問題を説明するHTTPコード400または500。

  1. 残りのウェブフックの受信をテストします:
    1. サンドボックスモードを使用して、サンドボックスモードを使用して、サブスクリプションの購入とアップデートをテストし、作成されたサブスクリプション更新されたサブスクリプション、およびキャンセルされたサブスクリプションのウェブフックを取得します。
    2. ライブモードを使用して、実際の支払いでサブスクリプションのテストを行い、それで、返金キャンセルされたサブスクリプションのウェブフックを取得します。

進捗状況
ご意見ありがとうございました!
最終更新日: 2022年8月8日

誤字脱字などのテキストエラーを見つけましたか? テキストを選択し、Ctrl+Enterを押します。

問題を報告する
当社は常にコンテンツを見直しています。お客様のご意見は改善に役立ちます。
フォローアップ用のメールをご提供してください
ご意見ありがとうございました!