跳到主要内容

Webhooks

Webhooks 允许你订阅 k-ID 引擎中发生的事件，而不是通过轮询 API 来查看数据是否可用。

Webhooks 可用于多种用途，例如：

处理成年人验证结果 处理年龄验证结果

设置 Webhooks​

Webhooks 在发布者门户中配置，你需要指定一个 URL，当事件发生时，k-ID 引擎将调用该 URL。该 URL 必须是一个安全的 HTTPS URL。k-ID 引擎会向该 URL 发送一个包含事件数据的 JSON 负载的 POST 请求。

Webhook 事件结构​

发送到 Webhook URL 的 JSON 负载将包含以下字段：

  • eventType - 发生的事件类型。
  • data - 与事件相关的数据。

一个 X-Event-Type 头部字段也将与事件类型一起发送。

将来，还会发送其他头部字段以验证请求的真实性。

Webhook 事件类型​

以下是可用的事件类型：

  • AdultVerification.Result （成年人验证结果）
  • AgeAssurance.Result （年龄验证结果）

成年人验证结果​

属性：

  • id - 唯一的验证 ID。
  • status - 可以是 PASS（通过）、FAIL（失败）或 INCONCLUSIVE（不确定）。
  • ageRange（可选）- 有关估算年龄范围的详细信息。

ageRange 属性：

minAge - 估算的最小年龄。 maxAge - 估算的最大年龄。 confidence - 表示对估算年龄范围的置信度的 0 到 1 之间的数字。

示例:

{
  "eventType": "AdultVerification.Result",
  "data": {
    "id": "5a58e98a-e477-484b-b36a-3857ea9daaba",
    "status": "PASS"
  }
}

年龄验证结果​

属性：

  • id - 唯一的验证 ID。
  • status - 可以是 PASS（通过）、FAIL（失败）或 INCONCLUSIVE（不确定）。
  • ageRange（可选）- 有关估算年龄范围的详细信息。

ageRange 属性：

minAge - 估算的最小年龄。 maxAge - 估算的最大年龄。 confidence - 表示对估算年龄范围的置信度的 0 到 1 之间的数字。

示例:

{
  "eventType": "AgeAssurance.Result",
  "data": {
    "id": "5a58e98a-e477-484b-b36a-3857ea9daaba",
    "status": "PASS",
    "ageRange": {
      "minAge": 18,
      "maxAge": 25,
      "confidence": 0.8
    }
  }
}