跳到主要内容

17 篇博文 含有标签「api」

查看所有标签

Widget URL 端点的法律文档选项

托管Widget URL 端点现在支持按调用传递法律文档变体，与 /age-gate/check 上已有的 options 对象一致。使用这些选项可在Widget同意流程中显示特定于平台的服务条款、隐私政策和附加法律链接（例如 Xbox、PlayStation 或 Steam），而非产品默认值。

新功能​

API 参考（OpenAPI）​

CDK：会话与权限​

  • 呈现法律文档和数据通知：说明了 termsOfServiceDocument、privacyPolicyDocument 和 additionalLegalLinks 是在整个 k-ID API 中命名法律文档变体的规范字段名，以及它们在各端点中的位置（在年龄验证检查和Widget URL 端点中位于 options，在 /session/upgrade 中位于 materialChange）。

Compliance Studio​

  • 附加法律链接：Variant ID 指南现在指向Widget URL 端点，而不仅仅是 /age-gate/check。

文档​

年龄验证结果现在会标明供应商

Verification.Result Webhook 和 GET /age-verification/get-status 现在会返回 provider，即执行该验证方法的供应商。

新增内容​

  • Webhook 和端点都包含 provider。 只要存在 method 就会提供，因此对于已完成的验证，你可以知道结果由哪家供应商产生。
  • 方法并不能唯一确定供应商。 age-estimation-scan 由多家供应商提供，而当支付代替验证时，credit-card 会携带记录商户（merchant of record）。请将 provider 用于自己的日志和分析，不要用于访问控制决策。
  • 其他内容均无变化。 所有其他字段的结构和存在规则保持不变。

文档​

用于家长电子邮件地址更改的新 Webhook

家长可以更改其 k-ID 账户的电子邮件地址，新的 Session.ApproverEmailUpdate Webhook 会在他们这样做时通知你的产品。

新增内容​

  • Session.ApproverEmailUpdate。 当家长提交电子邮件更改时，为每个孩子的会话各发出一次，使你的服务器能够更新为该玩家保存的家长电子邮件地址。负载中包含 id（会话）、productId、oldEmail 和 newEmail。
  • 会话在其他方面不会发生变化。 它仍为 ACTIVE，保留相同的 sessionId 和权限，孩子可以不受中断地继续使用。不要让玩家重新走一遍年龄验证或同意流程。
  • 仅限拥有活跃会话的孩子。 在你的产品中没有活跃会话的孩子没有可迁移的对象，因此不会为其发出事件。如果该孩子之后获得会话，该会话会直接基于新地址创建。
  • 需按端点订阅。 请在 Compliance Studio 中该产品的 Developer Settings 页面为你的 Webhook 端点选择 Session.ApproverEmailUpdate，否则 k-ID 会直接丢弃该事件，既不尝试投递也不返回错误。只有在你的组织启用了家长电子邮件更改后，该项才会出现在列表中。

文档​

交易与支付即验证指南

交易和支付即验证现已在开发者中心提供完整文档。

新功能​

  • 交易。 您的产品向 k-ID 报告孩子的购买，k-ID 将其呈现给已关联的家长，作为 Family Connect 中按孩子的购买视图以及定期活动摘要中的内容。在您希望在扣款前让家长参与其中的地方，购买批准请求会先请求他们批准，结果作为 Transaction.PurchaseApprovalResult webhook 到达。两个部分都在 Compliance Studio 中按产品配置。
  • 支付即验证。 一笔已完成的卡支付可以替代父母同意步骤，与信用卡验证方法一一对应：它恰好在会话启用了该方法的地方得到认可，仅限信用卡资金，而在其他所有地方，家长照常完成标准的可验证父母同意流程，不做改变。

文档​

已验证家长关联、屏幕时间和活动摄取指南

三项家长控制功能现已在开发者中心提供完整文档：已验证家长关联、屏幕时间和活动摄取。

新功能​

  • 已验证家长关联 (VPL)。 玩家可以邀请自己的家长进入您的产品；家长完成身份验证后，即可查看并设置该玩家的各项控制，例如屏幕时间。VPL 是关联而非门控：不会阻断任何内容，无论家长是否接受，您的产品都会照常运行。Session.Unlink webhook 会在任一方解除关联时通知您。VPL 按开发者组织启用。
  • 屏幕时间。 家长在 Family Connect 中为孩子设置每日限制、安静时段和休息提醒。您的产品报告使用情况并遵循 k-ID 返回的判定；k-ID 保存规则，按孩子按天计数使用时间，并评估安排。每项限制之前都会有一个警告事件，以便玩家能到达一个保存点；孩子也可以通过屏幕时间豁免来申请更多时间。
  • 活动摄取。 您的产品通过针对在 Compliance Studio 中按产品声明的活动类型推送记录，来报告孩子做了什么。k-ID 存储并汇总这些记录，反映到 Family Connect 中受信任的成人查看的界面（包括定期摘要电子邮件）。活动仅为入站方向。

文档​

通过 /session/delete 的新模式保护必需产品依赖关系

/session/delete 现在可以保护（或一并清理）依赖于被删除会话的其他产品。

新功能​

  • POST /session/delete 的 essentialDependencies。 当一个产品被配置为其他产品的*必需（essential）*产品时，以前删除其会话会静默地留下依赖产品的会话，使它们失去所依赖的同意基础。新字段让你可以选择替代行为，在默认撤销和 hardDelete 两种路径上均有效。
  • block 拒绝删除，而不是孤立依赖产品。 当玩家仍持有依赖被删除产品的活跃产品时，调用返回 ESSENTIAL_DEPENDENTS_EXIST 并列出依赖产品的 ID。无需启用。
  • cascade 会同时删除依赖的会话，然后删除指定的会话，每个会话都有自己的 Webhook 通知，硬删除时还有各自的删除记录。由于它会删除你未指定的会话，此模式按开发者选择加入（未启用时发送会返回 FEATURE_DISABLED），并且需要服务器端 API 密钥而非客户端访问令牌。
  • 所有现有调用均不受影响。 省略该字段或发送 ignore 时，/session/delete 的行为与以往完全一致，并且永远如此。这是一项稳定的可选功能，而不是默认行为变更的前奏。

文档​

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

现在提供了专用端点 /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 作为可信来源。

文档​