# AWS API Gatewayを使用したStripe Webhookの問題解決策

## 目次

1. はじめに

2. Stripe Webhookの概要

3. 問題の詳細

    1. constructEvent関数の動作

    2. JSON.stringifyの影響

4. 解決策

    1. Lambdaでの正しいペイロード処理

    2. constructEventを使用する際の注意点

5. まとめ

## 1. はじめに

Stripeは、オンラインでの決済処理を簡素化するために広く使用されている決済プラットフォームです。その中でもWebhookは、イベントドリブンな処理を行うために重要な役割を担っています。今回は、AWSのAPI GatewayとLambdaを用いてStripeのWebhookイベントを処理する際に発生する問題に対する解決策を提示します。

## 2. Stripe Webhookの概要

Stripe Webhookは、Stripeが特定のイベント（例：支払いの成功、顧客情報の更新など）が発生した際に事前に指定したURLに通知を送る仕組みです。これにより、リアルタイムでのデータ処理や状態管理が可能になります。

## 3. 問題の詳細

### 3-1. constructEvent関数の動作

StripeのSDKには、セキュリティを維持したままペイロードを検証するための`constructEvent`関数があります。この関数は、通常生のHTTPリクエストボディ文字列を受け取り、その正当性を確認するために署名を検証します。

### 3-2. JSON.stringifyの影響

AWS Lambdaでリクエストを処理する際、API Gatewayから受け取ったリクエストボディは自動的にJSONオブジェクトとして変換されることがあります。しかし、`constructEvent`関数は生の文字列を期待しています。そのため、`JSON.stringify`を使用してオブジェクトを文字列に変換しようとすると、元のイベントデータの字句的な構造が変更され、署名の検証に失敗する可能性があります。

## 4. 解決策

### 4-1. Lambdaでの正しいペイロード処理

LambdaがAPI Gatewayからのリクエストを受け取る際、リクエストボディが自動でJSONとして解析されることを防ぐために、API GatewayのIntegration Request設定を修正します。

1. **Raw Bodyとしての受け取り**: API Gatewayの設定で、リクエストのContent-Typeを`application/json`ではなく`application/json;charset=utf-8`に設定し、ペイロードが文字列としてLambdaに渡されるようにします。

2. **constructEvent関数使用時の正確な文字列渡し**:

   ```javascript

   const stripe = require('stripe')(process.env.STRIPE_SECRET_KEY);

   exports.handler = async (event) => {

     const sig = event.headers['Stripe-Signature'];

     const body = event.body; // ここでは生の文字列ボディを取得

     try {

       const stripeEvent = stripe.webhooks.constructEvent(body, sig, process.env.STRIPE_WEBHOOK_SECRET);

       // イベント処理

     } catch (err) {

       console.log(`Webhook Error: ${err.message}`);

       return {

         statusCode: 400,

         body: `Webhook Error: ${err.message}`,

       };

     }

   };

   ```

### 4-2. constructEventを使用する際の注意点

- **キーの管理**: StripeのWebhookシークレットキーを安全に管理し、ハードコードしないように注意します。

- **署名の確認**: constructEventはリプレイ攻撃を防ぐために署名の検証を行うので、この部分の処理は必ず外さないようにしてください。

## 5. まとめ

AWS API GatewayとLambdaを用いたStripe Webhookの処理には、ペイロードの解析方法に細心の注意を払う必要があります。特に、Stripeの`constructEvent`関数を利用してWebhookの署名を検証する際には、ペイロードが生の文字列として正しく扱われるように設定を工夫することが重要です。このガイドが適切なイベント処理の確立に役立つことを願っています。

AWS API Gatewayを使用したStripe Webhookの問題解決策

目次

続きを読むには単価診断を受けてください（30秒）