チュートリアル: API 製品を有料化する方法

オンラインで編集する

このチュートリアルでは、API 製品に対する価格プランの定義方法と、API 利用者がその収益化された製品をデベロッパーポータルで購読する方法を説明します。

開始前に

このチュートリアルを実行するには、以下の前提条件を満たす必要があります。
  • プロバイダー組織のオーナーであるか、またはSettings: ManageAPI Manager アカウントの権限。
  • システム管理者が管理システムで請求マイクロサービスを有効にする必要があります。
  • API Connect 管理サーバーがStripeアカウントと通信できるように、インターネットに接続できる環境が必要です。
  • Stripe のテスト・アカウントが必要です。 Stripe アカウントを持っていない場合、このチュートリアルの途中で作成できます。 Stripeアカウント（テストアカウントを含む）は、 https://dashboard.stripe.com/register で作成できます。

このチュートリアルについて

IBM® API Connect APIプロバイダーがAPI製品における価格プランを定義し、API提供による収益化を可能にするサブスクリプション課金機能が含まれています。 製品に価格設定プランが含まれている場合、API コンシューマーは、そのプランをサブスクライブする前に、支払情報を開発者ポータルに入力する必要があります。 API Connect Stripe Subscription Billingとの統合をサポートしています。これは、収益化された製品プラン、顧客、その支払い情報、および購読履歴を管理する独立したクラウドサービスで、毎月の請求書を作成し、顧客に自動的に課金することができます。 この統合により、Stripe はサブスクリプション請求システムと支払処理システムの両方の役割を果たします。

このチュートリアルでは、以下のアクティビティーを行います。
  1. 課金リソースを設定する
  2. stripe-test カタログの構成
  3. 開発者ポータルでStripe決済方法を有効にする
  4. 有料製品の作成と公開
  5. Stripe アカウントでの公開の検証
  6. 収益化された製品をデベロッパーポータルで表示

課金リソースを設定する

以下のステップを実行して、プロバイダー組織の Stripe 請求統合リソースを作成します。

  1. API Manager にログインしてください。
  2. ホームページで、「 リソースの管理 」タイルをクリックします。
    リソース管理タイル
  3. 「リソース 」ページで、以下の作業を行ってください。
    1. 左側のパネルで、 「請求」 を選択します。
    2. 右側のパネルで、 「追加」 をクリックします。

      請求関連リソースページ

      Stripe 連携用の「請求連携を追加」ページが表示されます。

  4. 「請求連携の追加」 ページで、以下の作業を行ってください。
    1. 「タイトル 」フィールドに、請求連携のタイトルを入力してください。 例えば、My Stripe Billingです。
      注： [名前 ] フィールドには、入力した [ 役職 ] に基づいて自動的に入力されます。
    2. 「公開用キー 」フィールドに、Stripeアカウントのテスト用キーを入力してください。
    3. 「 シークレットキー 」フィールドに、Stripeアカウントのテスト用キーを入力してください。
      ヒント： Stripeアカウントをお持ちでない場合は、こちらから作成できます： https://dashboard.stripe.com/register。 テスト用APIキーを取得するには、Stripeダッシュボードをご確認ください。 詳細については、 https://dashboard.stripe.com/apikeys をご覧ください。
      注： 各Stripeアカウントには、テスト用と本番用の2セットのAPIキーが付属しています。 API キーの各セットには、Stripe オブジェクト用の個別の名前空間があります。 テスト用の API キーでは、実動用の API キーで作成されたオブジェクトを参照できません (その逆も同様)。 請求統合の1つで使用しているAPIキーを、他のアカウントのキーに切り替えることはできません。また、テスト用と本番用のキーを入れ替えることもできません。これは、古いキーを使用して作成されたStripeオブジェクトを API Connect が解決できなくなるためです。 このチュートリアルでは、Stripe のテスト用の API キーを使用する必要があります。

    Stripeの統合ページ
  5. 「追加」をクリックして、Stripe 請求統合リソースを作成します。 「 My Stripe Billing 」の統合が、請求リソースとして表示されるようになりました。
    Stripe Billingの統合が請求リソースとして表示された

stripe-test カタログの構成

有料化された製品プランを公開するには、カタログに請求統合リソースを追加する必要があります。 このアクティビティーでは stripe-test という新しいカタログを作成します。このカタログは、必要に応じてチュートリアルの最後に削除できます。

  1. API マネージャー で、サイドナビゲーションバーの [ API Manager UIナビゲーションウィンドウのアイコンを管理する 管理] アイコンをクリックします。
  2. 「追加」 > 「カタログの作成」 をクリックし、新しいカタログを作成します。 stripe-test。
  3. stripe-test カタログ・タイルをクリックし、「カタログ設定」タブをクリックします。 ゲートウェイサービスを選択し、カタログが DataPower® Gateway (v5 compatible) または DataPower API Gateway 、あるいはその両方を使用するように設定されていることを確認します。 次に、 ポータルを選択し、 開発者ポータルを作成します。 これらの設定の方法がわからない場合は、 「カタログの作成と設定」 を参照してください。
  4. 請求連携リソースをカタログに追加するには、 「請求」 を選択し、「 編集 」をクリックします。
    カタログ請求の表示
  5. 前のステップで作成した「My Stripe Billing」リソースを選択し、「保存」をクリックします。
    マイ・ストライプ・ビリングの選択
    「My Stripe Billing 」が、stripe-test カタログの課金連携リソースとして登録されました。
    マイ・ストライプ・ビリングを表示したカタログ請求画面

開発者ポータルで Stripe決済方法を有効にする

API 利用者が有料プラン付きの製品を購読できるようにするには、 デベロッパーポータルで stripe-test カタログの Stripe 支払い方法を設定する必要があります。

  1. 管理者として開発者ポータルにログインします。
  2. 管理者ダッシュボードが表示されない場合は、「管理」をクリックして表示します。
  3. 管理者のダッシュボードで 、「拡張」 をクリックします。 「拡張」ページの「リスト」タブが開き、インストールされているモジュールのリストが表示されます。
  4. 検索フィルターに Stripe と入力し、「APIC の有料化での Stripe 統合」を選択して、「有効にする」をクリックします。
    APIC 収益化 Stripe 統合モジュールのインストール画面
    APIC Monetization Stripe Integration モジュールのデフォルト設定が有効になりました。これらの設定を編集する必要があります。
  5. [設定 ] > [システム ] > [ IBM API Connect の課金 ] をクリックします。
  6. 課金プロバイダー・モジュールのマッピングに関するドロップダウン・オプションを、新たに有効化された「 APIC Monetization Stripe Integration (ibm_stripe_payment_method) 」に変更し、「 設定を保存 」をクリックします。
    APIC 収益化用モジュール マッピング画面 Stripe 統合モジュール
  7. [設定] > [システム ] > [ IBM APIC Stripe 統合 ] をクリックし、 「請求リソースの設定 」の手順 4 で My Stripe Billing 統合リソースに入力したものと同じ Stripe テスト API 認証情報を入力します。 次に、「設定を保存」 をクリックします。これで、
    Stripe API キーの設定
    Stripeの支払い方法が開発者ポータルに設定されました。

有料製品の作成と公開

価格プランを含む製品を作成し、その製品をデベロッパーポータルに公開します。

  1. まず、製品で使用するテスト API をダウンロードする必要があります。
    • ストライプテストのカタログで DataPower Gateway (v5 compatible) を使用している場合は、 findbranch.txt ローカルのファイルシステムにファイルをダウンロードしてください。 このファイルの名前を findbranch.yaml に変更します。
    • ストライプテストのカタログで DataPower API Gateway を使用している場合は、 findbranch_v6.txt ローカルのファイルシステムにファイルをダウンロードしてください。 このファイルの名前を findbranch.yaml に変更します。
    あるいは、必要に応じて独自の API を使用することもできます。
  2. APIをインポートするには APIマネージャー、サイドナビゲーションバーの アイコン API ManagerのUIナビゲーションペインでアイコンを開発する開発する をクリックし、次に をクリックします 追加 > API（RESTまたは GraphQL SOAP）。
    API追加画面
  3. 「 OpenAPI 」 2.0 が選択されていることを確認し、 [インポート] セクションから 「既存の OpenAPI 」を選択して、 [次へ] をクリックします。
    既存の OpenAPI オプション
  4. 「ここにファイルをドラッグ・アンド・ドロップするか、クリックしてアップロードします」をクリックし、ローカル・ファイル・システム上の findbranch.yaml ファイルを選択してアップロードします。 次に、「次へ」 をクリックします。
    検証済みのファイルはインポート可能です
  5. 「API のアクティブ化」は、チェックを外したままにします。API のアクティブ化は、このセクションの後半部分で有料化した製品を公開する際に行います。 「次へ」 をクリックして先に進みます。
  6. 「 概要 」ページが表示され、API定義が生成されたことが確認できます。
    OpenAPI 2.0 の定義がインポートされたことを示す概要ページ
  7. 「APIを編集」 をクリックして生成されたAPI定義を確認し、サイドナビゲーションバーの「 API ManagerのUIナビゲーションペインでアイコンを開発する 開発 」アイコンをクリックして、収益化対象の製品の作成を続行してください。 「 FindBranch 」APIがAPI一覧に表示されるはずです。もし表示されない場合は、ブラウザの更新 API Manager UI ナビゲーションウィンドウのアイコンを更新する アイコンをクリックしてページを更新してください。
  8. 「追加」 >「 商品」 をクリック
    FindBranch APIの紹介ページを開発する
  9. 新しい製品を選択し、 次へをクリックします。
  10. 「 タイトル 」フィールドに FindBranches 「Enter」と入力し、 「次へ」 をクリックします。
    新しい製品情報ページを作成する
  11. インポートした FindBranch API、または独自の API を選択して、「次へ」をクリックします。
  12. プランはデフォルトのままにして、 次へをクリックします。 プラン（料金設定済み）は後で追加します。
    新しいデフォルトのプランページを作成する
  13. 「公開 」、「 表示設定 」、「 購読設定 」についてもデフォルト設定のままにし、「 次へ」 をクリックします。
    新しいデフォルトの公開ページを作成する
  14. 「 概要 」ページが表示され、新しい製品が作成されたことが確認できます。
    新しい製品概要ページを作成する
  15. 「製品の編集」をクリックして、構成を続行します。
  16. [ デザイン ] タブを選択した状態で、ナビゲーションメニューの [プラン] をクリックします。
    FindBranches 製品プランページ
  17. 「請求統合」セクションで、請求統合リソースとして my-stripe-billing を選択します。
  18. 「プラン」セクションで、「追加」をクリックして、価格設定が含まれる新規プランを作成します。
  19. 新規プランの「タイトル」を入力します (例えば、Gold)。ただし、「承認」チェック・ボックスのチェックは外したままにします。
  20. プラン価格のトグルをオンに変更すると、 プラン価格の定義セクションが表示されます。
  21. 「無料トライアル日数を含める」を選択し、サブスクライバーがプランを無料で使用できるトライアル日数をデフォルトの 1 のままにします。この日数を過ぎると、請求サイクルが開始されます。
  22. 繰り返しになりますが、 通貨はデフォルト設定 USD - US Dollar のままにし、加入者に請求する月額料金も 10 デフォルト設定のままにしておいてください。
    計画と価格設定のセクションを作成する
  23. 「プランのレート制限」セクションで、1 時間当たりの「呼び出し」を 1000 に変更し、このプランとデフォルトのプランを差別化します。 「保存」 をクリックして、新しい料金プランを保存してください。
    製品ページを保存
  24. これで、商品のアイコン 「オプション」アイコンオプション をクリックし、[公開] をクリックすることで 公開する、収益化された商品を stripe-test カタログに公開できるようになりました。
    製品ページを公開する
  25. stripe-test カタログが選択されていることを確認し、「公開」をクリックします。
  26. サイドナビゲーションバーの「 API Manager UIナビゲーションウィンドウのアイコンを管理する 管理 」アイコンをクリックし、「 stripe-test 」タイルを選択すると、 FindBranches 製品が公開されたことを確認できます。 「 FindBranches 」製品が、「製品 」タブに表示されるようになりました。
    縞模様テストカタログの製品タブ
    ヒント： 製品が表示されない場合は、必ず「 API Manager UI ナビゲーションウィンドウのアイコンを更新する 更新 」アイコンをクリックしてください。

Stripe アカウントでの公開の検証

以下のステップを実行することで、製品プランが Stripe アカウントに公開されたことを確認できます。

  1. Stripe テスト・アカウントにログインします。
  2. 開発者向けナビゲーションでイベントを選択します。
  3. 製品プランの公開時にイベントが作成されていることを確認します。

収益化された製品をデベロッパーポータルで表示

収益化された製品がデベロッパーポータルに表示されていることを確認するには、以下の手順を実行してください。

  1. ウェブブラウザで、stripe-testカタログ用の開発者ポータルを開きます。 ログインする必要はありません。
  2. ホームページに「 FindBranches 」製品が表示されているはずです。
    FindBranches 製品を表示する開発者ポータルホームページ
  3. 「FindBranches」タイルをクリックすると、デフォルト・プランと Gold プランの両方が表示されます。 Gold プランの価格設定情報を確認することができます。「2 レート制限」というテキスト上にカーソルを移動すると、レート制限の詳細が表示されます。 API利用者は、この有料プランに加入できるようになりました。
    FindBranches 製品に関するデベロッパーポータル内のゴールドプランの価格情報を示すプランページ

このチュートリアルで実行したこと

このチュートリアルでは、有料化された製品を作成および公開し、API コンシューマーがサブスクライブできるようにしました。 以下のアクティビティーを実行しました。

  • Stripe 請求統合リソースを作成しました。
  • stripe-test カタログを構成しました。
  • 開発者ポータルで Stripeを有効化。
  • 有料化された製品を作成および公開しました。
  • Stripe アカウントで公開を検証しました。
  • 収益化された製品を開発者ポータルで確認した。