Webhook を使用してアクションをトリガーする

アプリケーションに新しいエンドポイントを追加します。リクエスト本文で送信されたイベントオブジェクトの type フィールドを確認することにより、特定のイベントに対応できます。次に、Webhook が機能していることを確認するため、標準的な出力を確認できます。

新しいエンドポイントを追加した後で、サーバを起動します。

# Set your secret key. Remember to switch to your live secret key in production.
# See your keys here: https://dashboard.stripe.com/apikeys
Stripe.api_key = 
'sk_test_BQokikJOvBiI2HlWgH4olfQ2'

require 'stripe'
require 'sinatra'
require 'json'

# Using the Sinatra framework
set :port, 4242

post '/webhook' do
  payload = request.body.read
  event = nil

  begin
    event = Stripe::Event.construct_from(
      JSON.parse(payload, symbolize_names: true)
    )
  rescue JSON::ParserError => e
    # Invalid payload
    status 400
    return
  end

  # Handle the event
  case event.type
  when 'payment_intent.succeeded'
    payment_intent = event.data.object # contains a Stripe::PaymentIntent
    puts 'PaymentIntent was successful!'
  when 'payment_method.attached'
    payment_method = event.data.object # contains a Stripe::PaymentMethod
    puts 'PaymentMethod was attached to a Customer!'
  # ... handle other event types
  else
    puts "Unhandled event type: #{event.type}"
  end

  status 200
end

# Install Homebrew to run this command: https://brew.sh/
brew install stripe/stripe-cli/stripe

# Connect the CLI to your dashboard
stripe login

その他のインストールオプションについては、Stripe CLI を使ってみるをご覧ください。

Stripe CLI をインストールしたら、コマンドラインで stripe login を実行して Stripe アカウントにリンクするためのペアリングコードを生成します。Enter キーを押してブラウザを立ち上げ、アクセスを許可する Stripe アカウントにログインします。生成された API キーは 90 日間有効です。ダッシュボードの API キーの下で、キーを修正したり削除したりできます。

テスト

stripe login
Your pairing code is: humour-nifty-finer-magic
Press Enter to open up the browser (^C to quit)

既存の API キーを使用する場合は、--api-key フラグを使用します。

stripe login --api-key 
sk_test_BQokikJOvBiI2HlWgH4olfQ2
Your pairing code is: humour-nifty-finer-magic
Press Enter to open up the browser (^C to quit)

CLI を使用して、listen コマンドでローカル Webhook エンドポイントにイベントを転送します。

アプリケーションがポート 4242 で実行されていると仮定し、以下を実行します。

stripe listen --forward-to http://localhost:4242/webhook

別の端末タブで、trigger CLI コマンドを使用して模擬 Webhook イベントをトリガーします。

stripe trigger payment_intent.succeeded

listen タブには次のイベントが表示されます。

[200 POST] OK payment_intent.succeeded

サーバーを実行中の terminal タブに「PaymentIntent was successful! (PaymentIntent は正常に処理されました)」と表示されます。

Webhook エンドポイントを本番環境にデプロイする準備ができたら、以下を実行する必要があります。

1. テストキーではなく、本番環境の API キーを使用してください。

2. Stripe ダッシュボードまたは API で、Webhook エンドポイントを設定します。

ダッシュボードでエンドポイントを設定するには、Webhook の設定に移動します。

エンドポイントを追加をクリックして、エンドポイントの URL、Stripe API バージョン、および Stripe から送信する特定のイベントを入力します。

アプリケーションの Webhook エンドポイントのシークレットを、エンドポイントのダッシュボードに表示される新しいシークレットに置き換えます。

これで、アプリケーションで本番イベントを受け入れられるようになりました。Webhook エンドポイントの設定については、Webhook Endpoint API のドキュメントで詳細をご確認ください。サンドボックスでのテスト方法については、開発ガイドを参照してください。