RazorpayをShopify Flowに連携する方法

Razorpayは、インドで広く利用されている決済プラットフォームです。このプラットフォームでは、決済、返金、決済処理、定期購入に関してWebhookを送信します。「Workflow Webhooks」は、その呼び出しをShopify Flowのトリガーに変換するため、ストア側でそれに応じて対応することができます。具体的には、お客様へのタグ付け、注文メモの追加、社内メールの送信、メタフィールドの更新など、Shopify Flowで可能なあらゆる操作を行うことができます。

このガイドでは、一連の処理の流れ全体――Razorpayが送信し、Workflow Webhooksが受信・検証を行い、Shopify Flowが処理を行う――を設定します。すべてのリクエストにおいてRazorpayのHMAC署名が検証されるため、Razorpay以外がワークフローを開始することはできません。

どのようなものを作れるか

  • Razorpayの決済リンクまたはページを通じてお支払いいただいたShopifyのお客様にタグを付けてください。
  • Razorpay側で返金処理が行われた際には、注文メモを追加してください。
  • 決済が完了しましたら、財務チームにメールをお送りください。

送信される代表的なイベントは以下の通りです:payment.captured、payment.failed、refund.processed、subscription.charged。

始める前に

  • Workflow Webhooks Shopifyストアにインストールされています。
  • Shopify Flow インストール済みです。これは、ShopifyのApp Storeから無料で入手できます。
  • Webhookを作成する権限を持つRazorpayのアカウント。

ステップ 1 - Workflow Webhooks で Webhook を作成します

  1. Workflow Webhooks を開き**、[Webhook] → [Create Webhook]** の順に選択し、Shopify Flow で識別しやすい名前(例:Razorpay events)を付けてください。
  2. **「認証」**で、「**HMAC」**を選択してください。
  3. 「署名プロバイダー」で「Razorpay」を選択してください。アプリがヘッダー、アルゴリズム、署名済みペイロード、リプレイウィンドウを自動的に入力してくれます。これ以外に設定する必要はありません。
  4. 「シークレット」の欄はひとまず空のままにして、「保存」をクリックしてください。ページに表示されているWebhookのURLをコピーしてください。

その他の認証モードについては、認証 を、Shopify Flow に送信するフィールドの選択については、ペイロードのマッピングとShopify Flow変数 をご参照ください。

ステップ 2 - Razorpay にエンドポイントを追加する

Razorpayダッシュボードで、**「設定」→「Webhook」**を開き、コピーしたURLを使用してWebhookを追加し、イベントを選択して、シークレットを設定してください。

Razorpayの署名用シークレットを確認する方法

RazorpayダッシュボードのWebhookに設定されたシークレットです。

Webhookの署名に関するRazorpayの公式ドキュメント()には、お客様のアカウントに関する正確な説明文とスクリーンショットが掲載されています。

そのシークレットを、Workflow Webhooks の Webhook の**「Secret」**フィールドに貼り付けて、保存してください。それ以降、Razorpay からのすべての配信は、Shopify Flow に届く前に検証されるようになります。

これが何をチェックするのか

何 値
署名ヘッダー X-Razorpay-Signature
署名の位置 ヘッダー値全体
何が署名されたのでしょうか {body}
署名 HMAC-SHA256、16進数エンコード
タイムスタンプ この送信者には使用されていません
リプレイ防止機能 なし - この送信者はタイムスタンプに署名を行わないため、すべての有効な署名は引き続き有効です
その秘密 プレーンテキストとして使用します。送信者が表示しているとおりに、そのまま貼り付けてください。

署名付きペイロードにおいて、{body} は、バイト単位でリクエスト本体の生データそのものです。

これらのいずれかの条件を満たさないリクエストは、401 のエラーで拒否され、沿革とトラブルシューティング に記録され、ワークフローは開始されません。

ステップ 3 - 「Shopify Flow」ワークフローを作成する

  1. Shopify Flow でワークフローを作成し、「Workflow Webhooks」トリガーを選択してください。
  2. 「**イベントの記録」**をクリックし、Razorpayからテストイベントを送信してください(または、Workflow Webhooksの「テスト送信」機能をご利用ください)。これにより、Shopify Flowがデータの構造を学習します。
  3. 所有しているすべてのWebhookは同じFlowトリガーを起動するため、このワークフローをRazorpayのみに限定するには、Webhook IDを最初の条件として追加してください。IDはWebhookページに表示されています。
  4. アクションを追加してください ― お客様にタグを付ける、メモを追加する、社内メールを送信する、メタフィールドを更新する。
Shopify Flow
Shopify Flowで「トリガーを選択」を選択し、「Workflow Webhooks」を開き、「Webhookトリガー」を選択してください。
Shopify Flowの条件:Webhook IDが、あるWebhookのIDと一致すること
すべてのワークフローの最初のステップは、Webhook ID に基づく条件設定です。これにより、この Webhook に対してのみワークフローが実行されるようになります。
完成したワークフロー:Webhookトリガー、Webhook IDに基づく条件、そして「True」分岐で内部メールを送信します。
完成したワークフローは、トリガー、Webhook ID に基づく条件、そして「True」分岐でのアクションという流れになります。

ステップ4 - エンドツーエンドでテストする

Razorpayで実際のイベントをトリガーしてください。**「Workflow Webhooks」→「History」**に、ステータスが「**Success」**の呼び出しが表示されるはずです。署名が正しくなかった場合は、その理由が記載された失敗のエントリが表示されます。また、署名付きWebhookの検証 には、どのステップで失敗したかを正確に示す署名テスターの説明が記載されています。

「History」に、リクエストヘッダー、ペイロード、ステータス、所要時間、および識別子を含む1つの呼び出しが開かれました
「History」で配信されたイベント:ステータスが「Success」の場合、Shopify Flowがそれを受け入れたことを意味します。
署名が一致しません▾

順に、シークレット(最も一般的な原因として、余分なスペースや、異なる環境のキーが使用されていること)、送信者が別のエンドポイントのシークレットを使用しているかどうか、そしてRazorpayとアプリの間でボディが書き換えられていないかどうかです。署名は生のバイト列を対象としているため、JSONのフォーマットを変更するプロキシによって署名が破損してしまいます。 Webhookページの署名テスターには、署名された正確なテキストが表示されます。

どのリクエストでも401エラーが表示されます▾

Webhookの認証が**「HMAC」**に設定され、プロバイダーとして「Razorpay」が選択されていること、シークレットが入力されていること、そしてRazorpayがアプリに表示されているURL(末尾のコードを含めて)に正確にPOSTしていることをご確認ください。

「履歴」には何も表示されません▾

リクエストは届きませんでした。RazorpayでURLを再確認し、Razorpay側の配信ログで受信したレスポンスをご確認ください。「404」というエラーは、Webhookの設定が間違っているか削除されていることを意味します。「429」というエラーは、ご利用のプランの呼び出し制限を超えていることを意味します。詳細は プランと利用方法 をご参照ください。

ワークフローが誤ったイベントに対して実行されています▾

ストア内のすべてのWebhookは、同じShopify Flowトリガーを起動します。ワークフローの最初のステップとして、Webhook IDに基づく条件を追加するか、Razorpayから送信するイベントを絞り込んでください。

関連情報