やりたいこと
API Connectでは決済サービスであるStripeと連携する課金機能が提供されています。その機能を使って、課金プランの設定と、支払いがどのように行われるのかを、確認してみたいと思います。
前提事項
今回の環境は、IBM Cloud Public版のAPI Connectを利用しています。（2018年3月28日時点）
IBM Cloud Public版のAPI Connectを利用する場合、Enterprise Editionでなければ課金機能を利用することができないのでご注意ください。
また、API Connectのバージョンが異なる場合やテストする時期によっては、当記事の内容との差分が発生する可能性がありますので、あらかじめご了承ください。
参考マニュアル
- IBM API Connect v5.0 Knowledge Center : 製品の使用に対する請求
- IBM API Connect v5.0 Knowledge Center : [チュートリアル] 価格設定を伴うプランのサブスクライブ
手順
Stripeのアカウント作成
Stripeアカウントの作成サイトで、メールアドレス、名前、パスワードなどを入力して、アカウントを作成します。
携帯電話のリカバリ番号の登録画面では、とりあえずスキップしておきました。
Stripeのトップページが表示されました。
左上の「名称未設定のアカウント」をクリックし、「新規アカウント」選択して、アカウントを新規に登録します。
左側メニューから「開発者」を展開して「APIキー」を選択し、公開キーとシークレットキーを取得します。
API ConnectでのStripeとの連携の設定
APIマネージャーのメニューから、「管理」を開き、「請求」タブで「追加」ボタンから「Stripe統合」を選択します。
Stripeで取得した、公開鍵と秘密鍵を入力して「作成」をクリックします。
接続済みの状態でStripeとの連携設定が完了します。
API Connectでのカタログの設定
API製品を公開するカタログの設定で、「開発モード」をオフにしておきます。課金設定をしたプランが含まれる製品は、「開発モード」がオンのカタログには公開できない仕様となっているためです。
APIマネージャーのメニューから「ダッシュボード」を選択し、公開先のカタログ（今回の場合はサンドボックス）を選択します。
「設定」タブで「開発モード」をオフにして、保存します。
API Connectでの課金プランの設定と公開
新規製品を作成して、APIを追加して、課金設定されたプランを作ります。今回は課金機能のテストなので、APIはダミーのAPI定義でも構いません。
製品をステージングして公開します。
API Connectでテスト用の開発者組織の追加
支払いのテストを行うために、お金を支払うテスト用のユーザーを開発者組織のオーナーとして登録します。
APIマネージャーの対象のカタログの「コミュニティー」タブから、「追加」をクリックして、開発者組織を追加します。
開発者組織の名前をつけて、新規ユーザーを登録します。ここで指定するメールアドレスはテスト用なので、自分でメールが確認可能なメールアドレスとしてください。
開発者組織を追加すると指定したメールアドレス宛にアクティベーションリンクが届くので、リンクをクリックして、パスワード設定などを行い、アカウントを有効化します。
開発者ポータルでテスト用クレジットカードを利用した支払いのテスト
テスト用クレジットカードを利用した支払いのテストを行います。
前の手順で追加した開発者組織のユーザーで開発者ポータルにログインします。
ポータル右上のアカウント名をクリックして、「自分の組織」をクリックします。
「Billing」タブに移動し、「更新」ボタンをクリックして、メールアドレスや氏名、住所などを入力して、「決済情報入力へ」をクリックします。
<注意>ここで、氏名、住所などにはダブルバイト文字を入力しないようにしてください。製品の問題で保存ができない可能性があります。
Stripeで用意されているテスト用のクレジットカード情報から、VISA、Master、AMEXのいずれかのカード情報を入力して、「Update Billing Details」をクリックします。カード番号以外の項目はテストの場合、任意の値で問題ありません。
支払いのテストを行います。
「アプリケーション」タブに移動し、新規アプリケーションを登録します。
「API製品」タブに移動し、課金プランを設定した製品を選択します。
設定した課金プランが表示されるので、「配信登録」をクリックします。表示された画面で登録したアプリケーションにチェックを入れて「配信登録」をクリックします。
これでテスト用クレジットカードでの支払いが行われたはずです。
今回は、無料期間を指定していないので、配信登録するとすぐに支払いが行われます。以降毎月1回支払いが行われます。支払いを止める場合は、プランの登録解除を行う必要があります。
Stripe側で支払い状況を確認
Stripeで支払い情報を確認します。Stripeのダッシュボードの左側のメニューで「支払い」をクリックすると支払いが行われていることが確認できます。
以上、API ConnectのStripeと連携した課金機能を使ってみました。テスト用のクレジットカードが用意されているので、安心してテストすることができます。
ぜひ試してみてください。