跳到主要内容

6 篇博文 含有标签「api」

查看所有标签

年龄验证 API 响应中的短 URL 字段

年龄验证创建响应(来自 POST /age-verification/perform-access-age-verification 及其他 perform-* 年龄验证端点)现在除 idurl 外,还会返回 shortUrl

新功能

  • 短链接shortUrl 是较短链接,会重定向到与完整 url 相同的验证体验。当查询字符串过长不便使用时(例如生成二维码,或用户在另一台设备上完成验证),可使用它。
  • 完整 URL 不变:会话 JWT 仍位于完整 urltoken 查询参数中。请勿自行缩短或重新构造该 URL。
  • 不透明值:将 shortUrl 视为不透明字符串,按返回原样展示或编码;不要依赖固定的路径或查询结构,其形式日后可能会变。

了解更多

平台年龄信号文档

我们已发布 平台年龄信号 的端到端文档,说明 Apple iOS、Google Play、Xbox、Meta Horizon 与 k-ID 的年龄数据如何进入 k-ID、何时可以跳过年龄门,以及 已验证未验证 信号如何影响高风险权限与年龄保障流程。

新功能

CDK — 平台年龄信号

  • 平台年龄信号 — 快速集成路径、API 地图、推荐请求顺序、POST /age-gate/check 如何使用平台信号、支持的平台与 已验证声明类型,以及已验证与未验证信号的行为说明。
  • 平台信号详情 — 各平台的字段形态、如何获取各原生信号、按接口的说明(get-requirementscheckget-default-permissionssession/getget-platform-age-rangesession/upgrade)、校验、年龄冲突以及 k-id 信号规则。

概念与相关文档

  • 年龄信号 — 平台年龄信号与其他信号类型的关系,以及 PlatformAgeSignal 集成细节的查阅入口。
  • 高风险功能的年龄保障权限 — 关于 verifiedAgeThreshold 与在年龄门通过已验证平台信号满足条件的交叉引用说明。

API 参考(OpenAPI)

会话升级、AgeVerificationplatformAgeSignal 的描述已与上文文档统一为 已验证平台信号 的表述。

文档

Account System Product

我们已发布 Account System Product(账户系统产品)。该能力允许您组织的中央账户或平台产品使用单一 API 密钥和可选请求头,代表组织内其他产品创建认证挑战和会话。

新功能

Account System Product

在 Compliance Studio 中将某产品启用为 Account System Product 后,您可以通过在请求中携带 Kid-Target-Product-Id 头(值为目标产品 ID),代表同一组织内其他(非账户系统)产品调用特定 k-ID API。您使用 Account System Product 的 API 密钥即可,无需按目标产品管理或轮换密钥。

支持的端点:

家长仅会看到目标产品的配置(通知、权限、品牌)。账户系统产品和目标产品都会收到每个事件的 Webhook,其中包含 onBehalfOfProductIdinitiatedByProductId,便于您区分跨产品流程。

Account System Product 可与多产品批准配合使用:您可以将 Account System Product 设为目标产品的必备产品,这样家长在一次流程中即可同时批准两者。

文档

附加法律链接与 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-tosplaystation-privacy-policy)。当始终显示为关时必填。
  • 始终显示(默认)时,该链接在同意流程中始终显示。时,仅当您的游戏在 options 中传入对应变体 ID 调用年龄验证 API 时才显示。

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

Check age gate API — options 参数

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

  • termsOfServiceDocument:服务条款变体 ID(须与已配置的附加法律链接一致)。
  • privacyPolicyDocument:隐私政策变体 ID(须与已配置的附加法律链接一致)。
  • additionalLegalLinks:与服务条款和隐私政策一起显示的附加法律文档变体 ID 数组(每个须与已配置的附加法律链接一致)。

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

文档

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

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