跳到主要内容

6 篇博文 含有标签「documentation」

查看所有标签

浏览器和设备兼容性

我们已在文档中新增 浏览器和设备兼容性 页面，方便您快速查看我们年龄验证流程支持的浏览器和设备。

新功能​

浏览器和设备兼容性​

新页面列出桌面端和移动端的最低浏览器版本，以及嵌入式浏览器（iOS 的 ASWebAuthenticationSession、Android 的 Chrome Custom Tabs）的要求。它将我们各验证提供商的兼容性要求整合为单一参考。

新文档​

附加法律链接与 Check age gate 的 options

我们已补充 附加法律链接（Developer Details）及 Check age gate API 的 options 参数说明，便于在同意流程中展示平台相关法律文档（如 Xbox、PlayStation、Steam）。

新功能​

附加法律链接（Developer Details）​

在 Compliance Studio 的产品 Developer Details 标签页中，可添加在同意流程中显示的可选 附加法律链接：

  • 标题与链接：本地化显示标题与 URL（与主法律文档相同的语言选项）。
  • 变体 ID：调用 Check age gate API 时使用的标识符（如 xbox-tos、playstation-privacy-policy）。当始终显示为关时必填。
  • 始终显示：开（默认）时，该链接在同意流程中始终显示。关时，仅当您的游戏在 options 中传入对应变体 ID 调用年龄验证 API 时才显示。

当游戏在多个平台分发且各平台需使用不同法律文档 URL 时可使用此功能。

Check age gate API — options 参数​

POST /api/v1/age-gate/check 的请求体现支持可选的 options 对象：

  • termsOfServiceDocument：服务条款变体 ID（须与已配置的附加法律链接一致）。
  • privacyPolicyDocument：隐私政策变体 ID（须与已配置的附加法律链接一致）。

当创建挑战时，同意界面将显示所请求的法律链接，而非产品默认的 Privacy Policy 与 Terms of Service。

文档​

验证 URL 有效期与 get-status 文档

我们更新了年龄验证文档，补充了 URL 有效期、过期 URL 处理及状态查询说明。

新功能​

  • URL 有效期：验证 URL 自创建起 2 周内有效。过期时间位于 JWT 的 token 查询参数中，可使用标准 exp 声明判断 URL 是否仍有效。
  • 过期 URL：使用保存的验证 ID 调用 /age-verification/get-status。若未找到该验证，请创建新的验证。
  • 不依赖 URL 查询状态：使用验证 ID 调用 get-status 可随时查询状态（例如 URL 过期后或未收到 webhook 时）。
  • 保留期限：超过 2 周仍为 PENDING 的验证会被删除，get-status 将不再返回。

更新的文档​

验证文档更新

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

新功能​

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

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

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

新功能​

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

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

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

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

文档更新​

会话文档​

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

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

权限文档​

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

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

更改内容​

合并的文档​

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

后续步骤​

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

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