跳到主要内容

Webhooks 概述

Webhooks 通知您的服务器有关 k-ID 中的重要事件,例如挑战状态更改和验证结果。在 Compliance Studio 的开发者设置中为每个产品配置 Webhook URL 和密钥。

负载包括 eventTypedata 对象。有关负载架构,请参阅事件类型。

事件类型

事件类型说明
Challenge.StateChange当父母同意挑战更改状态时发出
Verification.Result在验证尝试结果时发出
Account.Delete当账户被删除时发出
AgeAssurance.Result在年龄保证评估结果时发出(已弃用,已替换为 Verification.Result
ParentalConsent.Granted当授予父母同意时发出
Session.ChangePermissions当父母修改会话权限时发出
Session.Delete当会话被删除时发出
Test用于验证 Webhook 是否正常工作

签名验证

使用配置的 Webhook 密钥验证 Webhook 请求。

标头

每个请求发送的标头:

  • X-Signature-Timestamp: UNIX 纪元秒数
  • X-Signature-Hmac-Sha256: (timestamp + raw body) 的 HMAC SHA-256,使用 Webhook 密钥作为密钥,十六进制编码(小写)

预期行为

  • 对于有效签名返回 200
  • 对于无效签名返回 401

有关实现详细信息,请参阅 验证 Webhook 请求