跳到主要内容

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

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

新功能​

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

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

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

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

文档更新​

会话文档​

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

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

权限文档​

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

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

更改内容​

合并的文档​

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

后续步骤​

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

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

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

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

新功能​

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

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

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

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

文档更新​

会话文档​

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

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

权限文档​

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

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

更改内容​

合并的文档​

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

后续步骤​

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

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

边缘情况处理示例

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

新功能​

边缘情况处理示例​

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

新示例包括：​

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

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

验证事件契约更新​

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

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

更新的文档​

移动应用集成指南和 ConnectID 测试更新

我们已添加了全面的移动应用集成文档，并增强了 ConnectID 测试资源，以帮助您将 k-ID 小部件集成到移动应用程序中。

新功能​

移动应用集成指南​

新的移动应用快速入门指南提供了将 k-ID 小部件集成到移动应用程序中的全面文档。该指南涵盖：

  • 平台特定的实现方法: Android（Custom Tabs、WebView、Trusted Web Activity）和 iOS（ASWebAuthenticationSession、SFSafariViewController、WKWebView）的详细指导
  • AgeKeys 支持: 关于哪些实现方法支持 AgeKeys 和 WebAuthn 的清晰文档
  • 结果通信: 接收小部件结果的两种方法—回调 URL（推荐）和 DOM 消息
  • 第三方应用验证流程: 关于 ConnectID 等验证方法如何通过第三方应用重定向的完整文档
  • 完整代码示例: iOS（Swift）和 Android（Kotlin）的分步实现示例，包含完整代码示例

ConnectID 测试增强​

使用移动应用测试资源增强 ConnectID 测试文档：

  • 移动应用测试应用: 添加了 iOS（TestFlight）和 Android（Google Play）的 ConnectID Mock Bank C 测试应用链接，以验证移动应用程序中的完整重定向流程
  • 测试部分更新: 通过专门用于移动应用重定向流程测试的子部分扩展了 ConnectID 测试部分

更新的文档​

介绍更新日志

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

新功能​

更新日志部分​

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

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

验证事件合约​

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

这意味着：​

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

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

保持更新​

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

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

订阅更新​

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

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

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

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