Webhook 签名验证
Webhook 签名验证
当您在 API 规范中定义 webhook 时,Fern 会自动生成实用程序,允许您的 SDK 用户验证 webhook 签名并确保事件来源于您的 API。
Fern 支持两种签名验证方法:
- 基于哈希的消息认证码(HMAC) — 使用共享密钥的对称密钥验证
- 非对称 — 使用 RSA、椭圆曲线数字签名算法(ECDSA)或 Ed25519 密钥的公钥验证
Webhook 签名验证目前仅支持 TypeScript SDK 生成。
生成的 SDK 行为
生成的 SDK 暴露了一个 verifyWebhookSignature 实用程序:
设置 webhook 签名验证
在您的 API 定义中配置签名验证。设置可以应用于文档级别(由所有 webhook 继承)或每个 webhook(覆盖文档级别的设置)。
OpenAPI
Fern Definition
openapi.yml
有关完整的配置详细信息,请参阅您的 API 定义格式的文档: