跳到主要内容

6 篇博文 含有标签「webhooks」

查看所有标签

年龄验证结果现在会标明供应商

Verification.Result Webhook 和 GET /age-verification/get-status 现在会返回 provider,即执行该验证方法的供应商。

新增内容

  • Webhook 和端点都包含 provider 只要存在 method 就会提供,因此对于已完成的验证,你可以知道结果由哪家供应商产生。
  • 方法并不能唯一确定供应商。 age-estimation-scan 由多家供应商提供,而当支付代替验证时,credit-card 会携带记录商户(merchant of record)。请将 provider 用于自己的日志和分析,不要用于访问控制决策。
  • 其他内容均无变化。 所有其他字段的结构和存在规则保持不变。

文档

用于家长电子邮件地址更改的新 Webhook

家长可以更改其 k-ID 账户的电子邮件地址,新的 Session.ApproverEmailUpdate Webhook 会在他们这样做时通知你的产品。

新增内容

  • Session.ApproverEmailUpdate 当家长提交电子邮件更改时,为每个孩子的会话各发出一次,使你的服务器能够更新为该玩家保存的家长电子邮件地址。负载中包含 id(会话)、productIdoldEmailnewEmail
  • 会话在其他方面不会发生变化。 它仍为 ACTIVE,保留相同的 sessionId 和权限,孩子可以不受中断地继续使用。不要让玩家重新走一遍年龄验证或同意流程。
  • 仅限拥有活跃会话的孩子。 在你的产品中没有活跃会话的孩子没有可迁移的对象,因此不会为其发出事件。如果该孩子之后获得会话,该会话会直接基于新地址创建。
  • 需按端点订阅。 请在 Compliance Studio 中该产品的 Developer Settings 页面为你的 Webhook 端点选择 Session.ApproverEmailUpdate,否则 k-ID 会直接丢弃该事件,既不尝试投递也不返回错误。只有在你的组织启用了家长电子邮件更改后,该项才会出现在列表中。

文档

交易与支付即验证指南

交易和支付即验证现已在开发者中心提供完整文档。

新功能

  • 交易。 您的产品向 k-ID 报告孩子的购买,k-ID 将其呈现给已关联的家长,作为 Family Connect 中按孩子的购买视图以及定期活动摘要中的内容。在您希望在扣款前让家长参与其中的地方,购买批准请求会先请求他们批准,结果作为 Transaction.PurchaseApprovalResult webhook 到达。两个部分都在 Compliance Studio 中按产品配置。
  • 支付即验证。 一笔已完成的卡支付可以替代父母同意步骤,与信用卡验证方法一一对应:它恰好在会话启用了该方法的地方得到认可,仅限信用卡资金,而在其他所有地方,家长照常完成标准的可验证父母同意流程,不做改变。

文档

已验证家长关联、屏幕时间和活动摄取指南

三项家长控制功能现已在开发者中心提供完整文档:已验证家长关联、屏幕时间和活动摄取。

新功能

  • 已验证家长关联 (VPL)。 玩家可以邀请自己的家长进入您的产品;家长完成身份验证后,即可查看并设置该玩家的各项控制,例如屏幕时间。VPL 是关联而非门控:不会阻断任何内容,无论家长是否接受,您的产品都会照常运行。Session.Unlink webhook 会在任一方解除关联时通知您。VPL 按开发者组织启用。
  • 屏幕时间。 家长在 Family Connect 中为孩子设置每日限制、安静时段和休息提醒。您的产品报告使用情况并遵循 k-ID 返回的判定;k-ID 保存规则,按孩子按天计数使用时间,并评估安排。每项限制之前都会有一个警告事件,以便玩家能到达一个保存点;孩子也可以通过屏幕时间豁免来申请更多时间。
  • 活动摄取。 您的产品通过针对在 Compliance Studio 中按产品声明的活动类型推送记录,来报告孩子做了什么。k-ID 存储并汇总这些记录,反映到 Family Connect 中受信任的成人查看的界面(包括定期摘要电子邮件)。活动仅为入站方向。

文档

FAIL状态Webhook事件现在包含ageCategory

我们已更新Verification.Result Webhook事件,当年龄数据可用时,在FAIL状态事件中包含ageCategory字段。

新功能

FAIL状态事件中的ageCategory

ageCategory字段现在包含在Verification.Result Webhook事件的FAIL状态中,当满足以下条件时:

  • failureReasonage-criteria-not-met
  • 年龄数据可用(age.lowage.high都存在)

这提供了更完整的用户年龄类别信息,即使由于年龄标准未满足而导致验证失败,也能在保持明确访问控制边界的同时,实现更好的分析和日志记录。

文档更新

Verification.Result文档已更新以反映此更改:

  • 字段表:更新描述以澄清FAIL状态时ageCategory何时存在
  • 主要差异表:澄清Webhook事件与API端点中ageCategory何时存在
  • FAIL状态字段存在规则:更新为在特定条件下将ageCategory显示为"有时包含"
  • 完整字段矩阵:更新为在Webhook的FAIL状态中将ageCategory显示为"sometimes²"
  • 示例负载:在FAIL状态示例中添加ageCategory以演示新行为
  • 实现检查清单:更新了处理FAIL状态中ageCategory的指导
  • 实现说明:澄清了PASS和FAIL两种状态中ageCategory的行为

重要提示

  • 访问控制:即使FAIL状态事件中存在ageCategory,也永远不要将其用于访问控制决策。始终使用status字段来确定访问权限。
  • 一致性:此更新适用于Webhook事件和API端点响应
  • 语言支持:所有语言版本(英语、日语、简体中文和韩语)已更新

下一步

  • 查看更新后的Verification.Result文档
  • 如果需要,更新您的集成以处理FAIL状态事件中的ageCategory
  • 请记住:当状态为FAIL时,即使字段存在,也永远不要将ageCategory用于访问控制。仅将其用于分析、日志记录或信息目的。

边缘情况处理示例

我们已在年龄验证指南中添加了全面的边缘情况处理示例,并更新了验证事件契约以澄清字段存在规则。

新功能

边缘情况处理示例

瀑布流指南现在包含用于处理验证边缘情况的详细代码示例。每个示例都演示了错误和正确的处理模式。

新示例包括:

  • 部分尝试(超过最大尝试次数): 当用户在没有确定性年龄判定的情况下用尽所有验证尝试时,正确处理 max-attempts-exceeded 失败原因
  • 检测到可疑活动: 以安全为重点处理 fraudulent-activity-detected 失败原因,包括适当的速率限制和安全措施
  • 完整的边缘情况处理程序: 一个综合的 TypeScript 示例,演示所有模式

所有示例都直接链接到验证事件契约以获取完整的字段存在规则。

验证事件契约更新

验证事件契约已更新以澄清字段存在规则:

  • ageageCategory 在 PASS 状态时始终存在: 所有导致 PASS 的验证方法都提供年龄信息和年龄类别。在处理 PASS 状态结果时,您可以在没有条件检查的情况下安全地访问这些字段。
  • 年龄范围说明: 当验证方法未提供确切年龄时,age.low 将是验证所需的阈值最小年龄,age.high 将为 100。

更新的文档