10 篇博文 含有标签「api」

/session/delete can now permanently erase a session instead of only revoking it.

What's new​

• confirmIrreversible on POST /session/delete. Set to true to permanently delete a player session and its embedded consent, scoped to the calling product. Unlike the default revoke (which is internally retained), this physically removes the record and can't be undone.
• Opt-in per developer. Available only to developers explicitly enabled for hard delete. Setting confirmIrreversible: true without enablement returns FEATURE_DISABLED.
• Every existing call is unaffected. Omitting confirmIrreversible, or setting it to false, behaves exactly as /session/delete always has: a reversible revoke.
• In-flight challenges are failed too. Any pending challenge tied to that exact session is set to FAIL, scoped to that session only (other sessions for the same player are untouched).

Documentation​

• /session/delete API reference

现在提供了专用端点 /age-verification/perform-credit-card-verification，用于仅以信用卡作为方式执行年龄验证，与现有的单一方式端点（ID、AgeKey、ConnectID）并列。

新功能​

• POST /age-verification/perform-credit-card-verification。 绕过自动方式选择，仅使用信用卡验证用户。它接受与其他单一方式端点相同的请求结构（jurisdiction、subject、criteria 以及可选的 options.redirectUrl / options.locale），并返回 id、url 和 shortUrl。
• 成人（18 岁以上）保证。 信用卡验证是一种成人保证信号，而非精确的年龄估计。它最适合卡片所有权仅限成人的司法管辖区。
• 状态和结果不变。 照常轮询 /age-verification/get-status 或处理 Verification.Result webhook。结果会将 credit-card 报告为验证 method。

文档​

• /age-verification/perform-credit-card-verification API 参考
• 单一方式验证流程
• 验证方式 → 信用卡验证

/age-gate/check now accepts a redirect URL that k-ID navigates to once an Automatic age assurance challenge completes. This is intended for top-level browser handoffs (such as a mobile webview that bounces out to k-ID and back) where an iframe-based result handler isn't an option.

What's new​

• options.playerAgeAssurance.redirectUrl. Pass an http(s) URL or a custom-scheme mobile deeplink (for example myapp://age-gate/return) on /age-gate/check. After the player completes or dismisses the CHALLENGE_AGE_GATE_AGE_ASSURANCE flow, k-ID redirects to that URL with challengeId, productId, sessionId (on PASS), and status (PASS or FAIL) appended as query parameters. Existing query parameters on the URL are preserved.
• Scope. The option is only honored for CHALLENGE_AGE_GATE_AGE_ASSURANCE. CHALLENGE_PARENTAL_CONSENT is unaffected and continues to return through the trusted-adult flow.
• Confirm outcomes server-side. The redirect query parameters are a UX hint. Treat the Challenge.StateChange webhook or /challenge/get-status as the source of truth before granting access.

Documentation​

• Age gate → Redirecting after the challenge
• /age-gate/check API reference
• Challenge.StateChange webhook

k-ID API 以及面向用户的年龄验证和家长同意流程的默认速率限制现已在专门的页面中提供。

新功能​

• API 速率限制。 对 k-ID API 的调用按产品进行限制：生产模式下为 500 RPS，测试模式下为 10 RPS。超出限制的请求将返回 HTTP 429 Too Many Requests。
• 年龄验证和家长同意流程速率限制。 面向用户的流程按产品进行限制：生产模式下为 100 RPS，测试模式下为 20 RPS。达到限制时，用户会看到流程内错误，提示其稍后再试（不会向您的服务器返回 429）。
• 申请提升。 这些是默认值。如果您的产品需要更高的容量，请联系您的 k-ID 代表。
• 更新了上线前检查清单。 CDK 和 AgeKit+ 上线前检查清单现在都明确提及速率限制，并链接到新页面，因为生产模式的上限明显高于测试模式。

文档​

• 速率限制
• 错误处理
• CDK 上线前检查清单
• AgeKit+ 上线前检查清单

年龄验证创建响应（来自 POST /age-verification/perform-access-age-verification 及其他 perform-* 年龄验证端点）现在除 id 与 url 外，还会返回 shortUrl。

新功能​

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

了解更多​

• 执行访问年龄验证
• 瀑布流
• 年龄验证快速入门
• 单方法流程
• 移动应用

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

新功能​

CDK — 平台年龄信号​

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

概念与相关文档​

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

API 参考（OpenAPI）​

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

文档​

• 平台年龄信号
• 平台信号详情
• 年龄信号
• 高风险功能的年龄保障
• 权限

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

新功能​

Account System Product​

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

支持的端点：

• /age-gate/check
• /challenge/send-email
• /challenge/generate-otp

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

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

文档​

• Account System Product – 实现指南、配置步骤、Webhook 载荷与安全说明

我们已补充 附加法律链接（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（须与已配置的附加法律链接一致）。
• additionalLegalLinks：与服务条款和隐私政策一起显示的附加法律文档变体 ID 数组（每个须与已配置的附加法律链接一致）。

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

文档​

• Developer Details — 基本信息（含附加法律链接）
• Check age gate（请求体与 CheckAgeGateRequestOptions）

我们已为 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/generate-age-gate-url

我们已澄清何时关闭年龄验证和 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