Skip to content

本文介绍如何使用 Hono 创建用于接收 Stripe Webhook 事件的 API。

准备工作

首先需要安装 Stripe 官方 SDK:

bash
npm install stripe

然后在 .dev.vars 文件中设置以下 Stripe API 密钥:

STRIPE_API_KEY=sk_test_xxx
STRIPE_WEBHOOK_SECRET=whsec_xxx

您可以通过以下文档了解 Stripe API 密钥的相关信息:

如何保护 Stripe Webhook 事件的 API

处理 webhook 事件的 API 是公开可访问的。因此,需要一个机制来防止攻击,例如恶意第三方伪造 Stripe 的 webhook 事件对象并发送请求。在 Stripe 的情况下,您可以通过发布 webhook 密钥并验证每个请求来保护 API。

了解更多:https://docs.stripe.com/webhooks?lang=node#verify-official-libraries

根据托管环境或框架实现 Webhook API

要使用 Stripe 执行签名验证,需要原始请求体(raw request body)。 在使用框架时,需要确保原始请求体不被修改。如果对原始请求体进行任何更改,验证将失败。

在 Hono 的情况下,我们可以通过 context.req.text() 方法获取原始请求体。因此,我们可以像以下示例一样创建 webhook API:

ts
import Stripe from 'stripe'
import { Hono } from 'hono'
import { env } from 'hono/adapter'

const app = new Hono()

app.post('/webhook', async (context) => {
  const { STRIPE_SECRET_API_KEY, STRIPE_WEBHOOK_SECRET } =
    env(context)
  const stripe = new Stripe(STRIPE_SECRET_API_KEY)
  const signature = context.req.header('stripe-signature')
  try {
    if (!signature) {
      return context.text('', 400)
    }
    const body = await context.req.text()
    const event = await stripe.webhooks.constructEventAsync(
      body,
      signature,
      STRIPE_WEBHOOK_SECRET
    )
    switch (event.type) {
      case 'payment_intent.created': {
        console.log(event.data.object)
        break
      }
      default:
        break
    }
    return context.text('', 200)
  } catch (err) {
    const errorMessage = `⚠️  Webhook 签名验证失败。${
      err instanceof Error ? err.message : '内部服务器错误'
    }`
    console.log(errorMessage)
    return context.text(errorMessage, 400)
  }
})

export default app

参考资料

Released under the MIT License.