跳到主要内容

11 篇博文 含有标签「api」

查看所有标签

电子邮件年龄估计专用年龄验证端点

现在提供了专用端点 /age-verification/perform-email-age-estimation，用于仅以电子邮件年龄估计作为方式执行年龄验证，与现有的单一方式端点（ID、AgeKey、ConnectID）并列。

新功能​

  • POST /age-verification/perform-email-age-estimation。 绕过自动方式选择，仅使用电子邮件年龄估计验证用户。它接受与其他单一方式端点相同的请求结构（jurisdiction、subject、criteria 以及可选的 options.redirectUrl / options.locale），并返回 id、url 和 shortUrl。subject.email 字段为可选项；如果省略，用户将在托管的验证页面上提供其电子邮件。
  • 18 岁以上信号。 电子邮件年龄估计是一种 18 岁以上信号，而非精确的年龄估计。它只能确定主体是否年满 18 岁，无法区分更年轻的年龄段，因此将请求标准与该能力相匹配是您的责任。
  • 状态和结果不变。 照常轮询 /age-verification/get-status 或处理 Verification.Result webhook。

文档​

Permanently erase a session with a new flag on /session/delete

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

What's new​

  • hardDelete 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 hardDelete: true without enablement returns FEATURE_DISABLED.
  • Every existing call is unaffected. Omitting hardDelete, 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​

信用卡专用年龄验证端点

现在提供了专用端点 /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。

文档​

自动年龄保证流程的重定向 URL

/age-gate/check 现在接受一个重定向 URL，k-ID 会在自动年龄保证挑战完成后跳转到该地址。此功能适用于无法使用基于 iframe 的结果处理程序的顶层浏览器切换场景（例如跳转到 k-ID 再返回的移动 webview）。

新功能​

  • options.playerAgeAssurance.redirectUrl。 在 /age-gate/check 上传入 http(s) URL 或自定义方案的移动深层链接（例如 myapp://age-gate/return）。当玩家完成或关闭 CHALLENGE_AGE_GATE_AGE_ASSURANCE 流程后，k-ID 会重定向到该 URL，并将 challengeId、productId、sessionId（PASS 时）和 status（PASS 或 FAIL）作为查询参数附加。URL 上现有的查询参数会被保留。
  • 范围。 该选项仅对 CHALLENGE_AGE_GATE_AGE_ASSURANCE 生效。CHALLENGE_PARENTAL_CONSENT 不受影响，仍通过可信成人流程返回。
  • 在服务器端确认结果。 重定向查询参数只是 UX 提示。在授予访问权限之前，请将 Challenge.StateChange webhook 或 /challenge/get-status 作为可信来源。

文档​

速率限制文档

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+ 上线前检查清单现在都明确提及速率限制，并链接到新页面，因为生产模式的上限明显高于测试模式。

文档​

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

年龄验证创建响应（来自 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

我们已发布 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，其中包含 onBehalfOfProductId 和 initiatedByProductId，便于您区分跨产品流程。

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-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。

文档​

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​