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

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

• API経由（サーバーレス統合に該当する）
• ウェブフック経由（自動通知、サーバー統合に該当する）

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

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

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

• ログインとパスワードによる認証を行う場合は、新規ユーザー登録とユーザー名とパスワードによる認証APIコールを使用してください。
• ソーシャルネットワークを介して認証する場合は、ソーシャルネットワークによる認証APIコールを使用します。

パスパラメータprojectIdにプロジェクトIDを指定します。このパラメータは、アドミンページでプロジェクト名の横に表示されています。クエリパラメータとして指定します：

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

-X 'GET' \
  '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'

応答の例：

{
  "items": [
    {
      "id": 11111111,
      "plan_id": 11111
      "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": 1,
        "unit": "day"
      }
    }
  ],
  "has_more": true
}

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

1. ウェブフック受信のパラメータを構成にするには：
   1. アドミンページでプロジェクトを開きます。
   2. サイドメニューの「プロジェクト設定」をクリックし、「ウェブフック」タブに移動します。
   3. 「ウェブフックサーバー」フィールドに、https://example.com形式でウェブフックを受信したいサーバーのURLを指定します。ウェブフックをテストするツールで見つけたURLを指定することもできます。
   4. プロジェクトのウェブフックに署名するための秘密鍵がデフォルトで生成されます。新しい秘密鍵を生成したい場合は、更新アイコンをクリックします。
   5. 「ウェブフックを有効にする」をクリックします。

2. 以下の種類のウェブフックの処理をアプリケーションに実装してください。
   • サブスクリプションを購入して更新するには：
     • ユーザー検証
     • 決済
     • 作成されたサブスクリプション
     • 更新されたサブスクリプション
   • サブスクリプションをキャンセルするには：キャンセルしたサブスクリプション
   • 返金するには：返金

3. ウェブフックをテストします：
   1. アドミンページ> プロジェクト設定 > ウェブフックで、サブスクリプションタブに移動します。

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

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

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

次のステップ

1. ユーザー認証をセットアップします。
2. サンドボックスモードでウェブショップをテストします。

お役立ちリンク

統合フロー