Webhookを使ってStripeの決済結果をSalesforceで管理しよう
Webサイト上で商品を購入したり、イベントに申し込んだりした経験がありますよね。
今回はいくら決済されたのかSalesforceに記録を残してみようと思います。Apex初挑戦です!
決済サービスもいくつかありますが今回はStripeを利用します。
Stiripeとは
120ヵ国、数百万の企業が導入しているオンライン決済システムです。
135を超える通貨に対応し、クレジットカードやウォレットなど複数の決済方法にも対応しています。
クレジットカード決済の場合、日本 のユーザーは、Visa, Mastercard, American Express, Discover, JCB, Diners Club、デビットカードに対応しています。
実現イメージ
今回はStripeでの決済完了後にSalesforceのケースを1件登録する処理を実現します。
決済機能は任意の環境で構築します。
SalesforceのExperience Cloudでも、JavaでもC#でもOKです。
Stripeでは2種類の構築方法があります。
- 構築済みのCheckoutページ
- カスタム決済フロー
どちらも複数の言語でサンプルが提供されています。
メリット | デメリット | |
構築済みのCheckoutページ | 開発期間が短い | 画面デザインのカスタマイズができない 機能面はある程度のカスタマイズのみ |
カスタム決済フロー | 画面デザインや機能の自由度が高い | 一から構築が必要なため時間がかかる |
決済画面の構築は割愛しますが、「構築済みのCheckoutページ」を利用しました。
Webhookで通知する
今回の目的である決済結果をSalesforceで取得するためにWebhookを利用します。
WebhookとはWebアプリケーションで特定のイベントが発生した際に別のWebアプリケーションにHTTPで通知する仕組みです。
その通知をキャッチして様々な処理を実行することができます。
①Salesforce側の受け口を作成
Apexを利用してWebhookの通知を受け取って実行するクラスを作成します。
Trailheadの「Apex Web サービス」「Apex REST コールアウト」を参考にしました。
決済が成功したらケースを作成します。
Stiripeの返却値から支払金額を取得して、ケースのタイトルに登録します。
@RestResource(urlMapping='/Cace/*')
global without sharing class CheckoutResult{
@HttpPost
global static void doPost(){
RestRequest req = RestContext.request;
Map<String, Object> requestParams = (Map<String, Object>)JSON.deserializeUntyped(req.requestBody.ToString());
//階層ごとにデータを抽出
Map<String, Object> paramData = (Map<String, Object>)requestParams.get('data');
Map<String, Object> paramObject = (Map<String, Object>)paramData.get('object');
Integer amount = (Integer)paramobject.get('amount');
//ケースに登録
Case thisCase = new Case(
Subject=amount +'円の入金がありました',
Priority='Medium',
Status='New',
Origin='Email');
insert thisCase;
}
}
テストクラス
Webhookで返されるbodyのテスト値は静的リソースを利用しました。
SrtipeのWebhookページで、どのようなbodyが返されるか確認できます。
@isTest
Public class TestCheckoutResult {
@isTest
static void testCheckoutResult() {
StaticResource sr = [SELECT Id, Body FROM StaticResource WHERE Name = 'GetWebhookResource' LIMIT 1];
String body = sr.Body.toString();
RestRequest req = new RestRequest();
RestResponse res = new RestResponse();
req.requestURI = '/services/apexrest/Checkout/'; //Request URL
req.httpMethod = 'POST'; //HTTP Request Type
req.requestBody = Blob.valueof(body);
RestContext.request = req;
RestContext.response= res;
Test.startTest();
CheckoutResult.doPost();
Test.StopTest();
}
}
※静的リソースに使用したbodyのサンプルは、下記「bodyの確認方法」に記載します。
②Salesforceのサイトを作成
「設定」からクイック検索に「サイト」と入力します。
「新規」ボタンからサイトを作成します。
「公開アクセス設定」から「有効な Apex クラス」に①で作成したCheckoutResultを設定します。
③Stripe側のWebhook設定
REST サービスをコールするために使用されるエンドポイントで、
@RestResource(urlMapping=’/Cace/*’)で指定したCaceをURL末尾に指定します。
https://yourInstance.my.salesforce.com/services/apexrest/Case/
「yourInstance.my.salesforce.com」には②で作成したサイトのカスタムURLのドメイン名が入ります
URLが確認できたら、Stripeの開発者画面のWebhookページを開きます(画面は既に設定済み)
エンドポイントの編集画面を開き、エンドポイントURLに先ほどのURLを設定し、送信したいイベントを指定します。
今回は決済成功時に送信したいので、「payment_intent.succeeded」を選択します。
決済してみよう
「構築済みのCheckoutページ」を利用して作成した決済画面に必要事項を入力して支払うボタンをクリックします。
支払い金額10,000円をタイトルに含んだケースが作成されました!
※bodyの確認方法
テストで使用したbodyのサンプルの取得方法です。
Stripeの開発者画面のWebhookページから「テストイベントを送信」を選択します。
「payment_intent.succeeded」を指定して「テストのWebhookを送信」をクリックします。
リクエスト部分にbodyが表示されます。
こちらを静的リソースに登録します。
最初はbodyから取得をせず、決済したら固定文字でケースを作成するところから始めると良いと思います。
最後に
ずっと避けていたApexさん…
Apexは一度セミナーを受けた程度で、一から構築するのが初めてでしたので結構苦戦しました。
StripeもWebhookも初めてだったので、もっとシンプルなところから入れば良かったのですが…
初めてでもTrailheadを駆使してなんとかここまでできました!サンプルがあるのは有難いですね。
Stripeもサンプルが充実しているので、ある程度プログラム経験があればサクッと導入できて良いなと思いました。
今回はケースのタイトルに金額を登録するシンプルなものでしたが、Stripeからの返却値を使って、日付や数量をレコードに登録して、集計、グラフ化などしてみるのも良いですね。
これを機にApexもパッとできるように頑張ります!
ではまた…!