事件概述
k-ID 提供两种类型的事件，帮助您实时响应用户操作和系统更改 - DOM 事件和Webhooks。这两种事件类型都允许您构建响应式集成，以响应 k-ID 系统中的重要更改。
什么是事件？
事件是 k-ID 在应用程序中发生特定操作时发送的通知。它们允许您：
- 响应用户操作：当用户完成验证、授予同意或与小部件交互时立即响应
- 更新应用程序状态：使您的应用程序与 k-ID 的状态更改保持同步
- 处理异步操作：在长时间运行的流程完成时接收通知
- 构建实时体验：创建自动更新的响应式用户界面
DOM 事件
DOM 事件是由在您网站上 iframe 中运行的 k-ID 小部件发出的 JavaScript 事件。这些事件通过浏览器的 postMessage API 发送，可以使用标准 JavaScript 事件监听器进行监听。
何时使用 DOM 事件
- 响应式 UI 更新：当用户与小部件交互时立即更新您的界面
- 客户端交互：当您需要在浏览器中响应小部件交互时
- 实时用户反馈：向用户提供即时视觉反馈
主要特性
- 直接从 iframe 中的小部件发出
- 通过 JavaScript
message事件监听器接收 - 需要源验证以确保安全
- 非常适合客户端 JavaScript 应用程序和响应式 UI
有关详细信息，请参阅 DOM 事件。
Webhooks
Webhooks 是从 k-ID 服务器发送到您服务器端点的 HTTP POST 请求。它们提供有关 k-ID 系统中重要事件的服务器到服务器通知。
何时使用 Webhooks
- 数据完整性：可靠地更新数据库并保持数据一致性
- 服务器端处理：当您需要在服务器上处理事件时
- 可靠交付：对于即使用户离开也必须处理的关键事件
- 后台处理：异步处理事件而不阻塞用户交互
- 状态同步：使您的服务器状态与 k-ID 的状态保持同步
主要特性
- 作为 HTTP POST 请求发送到您配置的端点
- 包含用于安全验证的加密签名
- 在 Compliance Studio 中为每个产品配置
- 非常适合服务器端集成、数据完整性和可靠的状态管理
有关详细信息，请参阅 Webhooks。
在 DOM 事件和 Webhooks 之间选择
两种事件类型服务于不同的目的，可以一起使用：
| 用例 | 推荐方法 |
|---|---|
| 浏览器中的实时 UI 更新 | DOM 事件 |
| 数据完整性和状态管理 | Webhooks 或服务器端 API 调用 |
| 服务器端处理和数据库更新 | Webhooks |
| 响应式用户反馈 | DOM 事件 |
| 可靠的事件处理 | Webhooks |
| 小部件交互 | DOM 事件 |
最佳实践
使用 DOM 事件进行响应式 UI 更新，使用 webhooks 或服务器端 API 调用（如 /age-verification/get-status 或 /challenge/get-status）进行数据完整性和可靠的状态管理。许多应用程序同时使用两者，DOM 事件用于即时 UI 反馈，Webhooks 用于可靠的服务器端处理和数据持久化。
开始使用
- DOM 事件 - 了解小部件发出的 DOM 事件
- Webhooks - 了解 Webhook 配置和处理
- 事件结构 - 探索可用的事件类型和负载
- Webhook 事件类型 - 探索可用的 Webhook 事件类型