API 概述
年龄门、会话、权限、同意质询与年龄验证，统一在一个 HTTP RPC 接口之下。
k-ID API 是一个 HTTP RPC 风格的 Web API，用于与 k-ID 交互。它提供启动可验证父母同意 (VPC)、启动年龄验证以及获取玩家启用权限的方法。
API 结构
k-ID API 是 HTTP RPC 风格方法的集合。所有 URL 的格式为 https://{host}/api/v1/{method}。虽然它不是 REST API，但熟悉 REST 的人应该熟悉其基于 HTTP 的基础。所有 API 方法都使用 GET 或 POST HTTP 方法，具体取决于 API 是否有副作用。
参数作为 GET 方法的查询参数传递，作为 POST 方法请求正文中的 JSON 传递。所有响应都是 JSON 格式。
基础 URL
生产模式：
https://game-api.k-id.com/api/v1/测试模式：
https://game-api.test.k-id.com/api/v1/端点
年龄门控
| 端点 | 说明 |
|---|---|
/age-gate/get-requirements | 获取司法管辖区的年龄门控要求 |
/age-gate/check-age-category | 检查玩家的年龄类别 |
/age-gate/check | 检查年龄并创建或更新会话 |
/age-gate/get-default-permissions | 获取司法管辖区的默认权限 |
会话
| 端点 | 说明 |
|---|---|
/session/get | 通过会话 ID 或 kuid 获取会话 |
/session/upgrade | 升级会话权限 |
/session/update-jurisdiction | 更新会话司法管辖区 |
/session/set-guardian-managed-session-permissions | 设置监护人管理的会话权限 |
/session/unlink-parent | 从会话解除家长关联 |
挑战
| 端点 | 说明 |
|---|---|
/challenge/get | 获取挑战详细信息 |
/challenge/get-status | 获取挑战状态 |
/challenge/send-email | 发送挑战电子邮件通知 |
/challenge/generate-otp | 为挑战生成一次性密码 |
/challenge/invite-parent | 创建家长邀请挑战 |
/challenge/cancel-invite | 取消家长邀请 |
/challenge/send-email-with-payment-verification | 发送带支付验证的邮件 |
年龄验证
小部件
| 端点 | 说明 |
|---|---|
/widget/generate-age-gate-url | 生成年龄门控小部件 URL |
/widget/generate-direct-notices-url | 生成数据通知小部件 URL |
/widget/generate-manage-session-permissions-url | 生成会话权限管理小部件 URL |
/widget/generate-e2e-url | 生成端到端小部件 URL |
屏幕时间
| 端点 | 说明 |
|---|---|
/screentime/start | 开始屏幕时间 |
/screentime/end | 结束屏幕时间 |
/screentime/push | 提交会话已完成的屏幕时间使用片段 |
/screentime/request-override | 请求屏幕时间豁免 |
/screentime/get-state | 获取屏幕时间状态 |
活动
| 端点 | 说明 |
|---|---|
/activity/push | 推送会话的活动记录 |
/test/send-activity-digest | 发送测试每周活动摘要电子邮件 |
交易
| 端点 | 说明 |
|---|---|
/transaction/push | 提交会话已完成的资金流转交易 |
/transaction/request-purchase | 为购买请求家长批准 |
/transaction/lookup-provider | 将名义销售方的支付信息规范化为标准格式 |
测试
| 端点 | 说明 |
|---|---|
/test/set-challenge-status | 设置挑战状态（仅测试） |
/test/set-age-verification-status | 设置年龄验证状态（仅测试） |