跳到主要内容

16 篇博文 含有标签「changelog」

查看所有标签

Age Gate Widget 重定向 URL 支持

我们已为 Age Gate Widget 端点添加了 redirectUrl 作为可选参数。

新功能​

Age Gate Widget API 更新​

/widget/generate-age-gate-url 端点现在支持在 options 对象中使用可选的 redirectUrl 参数。这允许您指定在 Age Gate Widget 完成后重定向到的 URL，类似于端到端 Widget 端点。

redirectUrl 参数支持 HTTP/HTTPS URL 或具有自定义协议方案的移动端深度链接。

更新的 API​

验证文档更新

我们已更新验证文档，改进了方法字段描述并澄清了指导。

新功能​

Verification Result 文档​

更新了 Verification.Result Webhook 文档:

  • ageCategory 指导: 明确了 PASS 状态时 ageCategory 始终存在，应将其用于访问控制决策，而不是使用原始年龄值
  • 方法字段更新:
    • 从方法字段列表中移除了 self-confirmation 和 email-confirmation
    • 更新了 age-estimation-scan 的描述，表明它是返回年龄范围的面部年龄估计扫描（无 DOB）

更新的文档​

Widget.ExitReview 澄清和 API 更新

我们已澄清何时关闭年龄验证和 VPC 流程的窗口小部件 UI，并在 MegaWidgetOptions 架构中添加了 redirectUrl 支持。

新功能​

Widget.ExitReview 澄清​

我们已更新文档，明确 Widget.ExitReview 是应确定何时关闭年龄验证和 VPC 流程 UI 的信号。

更新的文档:

  • 年龄验证指南 - 添加了有关监听 Widget.ExitReview 以关闭验证 UI 的指导
  • VPC 指南 - 添加了有关监听 Widget.ExitReview 以关闭 VPC 窗口小部件 UI 的指导
  • CDK 嵌入式流程 - 添加了有关监听 Widget.ExitReview 以关闭窗口小部件 UI 的指导

所有语言版本（英语、日语、简体中文和韩语）均已更新此澄清。

API 更新​

MegaWidgetOptions 中的 redirectUrl​

MegaWidgetOptions 架构现在包含 redirectUrl 支持，与年龄验证请求架构一致。这允许您在使用端到端窗口小部件时指定重定向 URL。

更新的架构:

  • MegaWidgetOptions 现在包含对 #/components/schemas/RedirectUrl 的引用的 redirectUrl 字段

此更改在所有 OpenAPI 规范文件（英语、日语、简体中文和韩语）中可用。

文档改进​

产品图片规格​

为 Compliance Studio 的产品图片添加了推荐的宽高比和分辨率:

  • Logo: 1:1（正方形），512×512px
  • Banner: 3:1（横向），2430×810px

FAIL状态Webhook事件现在包含ageCategory

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

新功能​

FAIL状态事件中的ageCategory​

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

  • failureReason为age-criteria-not-met
  • 年龄数据可用（age.low和age.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用于访问控制。仅将其用于分析、日志记录或信息目的。

新的会话和权限指南及文档更新

我们添加了一个全面的会话和权限管理指南，并更新了核心概念文档，添加了重要的说明。

新功能​

新指南：管理会话和权限​

我们添加了一个新的快速入门指南：管理会话和权限。本指南提供了以下步骤说明：

  • 使用 Webhook 和会话比较检测权限更改
  • 处理会话删除和撤销
  • 向玩家传达权限更改
  • 实现权限升级流程
  • 了解挑战如何与会话相关

本指南对于需要随时间响应权限更改的任何集成都是必不可少的，例如当父母修改设置或玩家年龄增长时。

文档更新​

会话文档​

会话概念页面已更新，添加了重要说明：

  • 会话 ID 持久性：玩家每个产品只有一个会话。会话 ID 在权限更改期间保持不变，但如果会话被撤销并再次完成同意流程，则会创建新的会话 ID。
  • 会话删除行为：已删除的会话返回 HTTP 400，错误代码为 NOT_FOUND（不是 404）。这是有意的—已删除的会话应被视为从未存在过。
  • 年龄升级更改：年龄升级事件不会触发 Webhook 通知。您必须使用会话比较来检测这些更改。

权限文档​

权限概念页面已增强，包含：

  • managedBy 字段更改：明确说明 managedBy 可能随时间变化（例如，当玩家年龄增长时从 GUARDIAN 变为 PLAYER）。
  • 玩家管理的权限：当玩家通过 /session/upgrade API 请求启用 PLAYER 管理的权限时，它会自动启用而不会创建挑战。
  • 权限升级内容：权限升级文档已合并到权限页面，以便更好地发现。

更改内容​

合并的文档​

  • 权限升级概念页面已合并到权限页面。所有引用已更新为指向新位置。

后续步骤​

  • 查看新的管理会话和权限指南
  • 确保您的集成正确处理会话删除（HTTP 400，错误代码为 NOT_FOUND）

如果您对这些更新有任何疑问或需要集成方面的帮助，请随时联系我们的支持团队。

介绍更新日志

我们很高兴推出新的更新日志部分！这将作为一个集中位置，让您了解开发者接口、API 行为和集成模式的更改。

新功能​

更新日志部分​

从今天开始，您可以在一个方便的位置找到开发者相关更改的更新。我们将定期在此发布更新，帮助您了解：

  • API 更新和更改：新端点、参数修改和弃用
  • 事件系统更新：DOM 事件和 Webhook 的更改
  • 接口和行为更改：开发者接口和集成模式的更新
  • 重大更改：可能影响您集成的重要更新

验证事件合约​

我们正在引入验证事件合约，为开发者提供关于所有验证结果数据预期格式的可靠参考资料。此合约适用于 DOM 事件和 Webhook，我们承诺将其作为您集成的稳定参考进行维护。

这意味着：​

  • 一致的事件结构：所有事件类型中可预测的事件负载
  • 全面的文档：完整的事件架构和示例，便于集成
  • 可靠的参考：我们承诺将此合约作为验证结果数据格式的稳定参考资料进行维护

有关事件结构以及如何在集成中使用它们的详细信息，请参阅我们的事件文档。

保持更新​

将此更新日志加入书签并定期查看，或订阅我们的更新以了解 k-ID 平台的最新更改。我们致力于让您了解可能影响您集成的所有更新。

有关高级产品公告和功能发布，请参阅我们的发布说明。

订阅更新​

您可以使用您喜欢的 feed 格式订阅更新日志：

将任何这些 feed URL 添加到您的 RSS 阅读器、新闻聚合器或监控工具中，即可在新更新日志条目发布时自动接收通知。

如果您对这些更新有任何疑问或需要集成方面的帮助，请随时联系我们的支持团队。

这是我们更新日志的第一条条目。当开发者接口和行为发生变化时，我们将继续在此发布更新。