测试
测试您的 k-ID 集成对于确保在上线前正常工作至关重要。本指南涵盖 k-ID 平台中可用的测试策略和工具。
测试模式和实时模式
k-ID 提供两个用于测试和生产的环境:
测试模式
测试模式 允许开发者在不影响真实数据或生产系统的情况下测试集成。使用测试模式 API 密钥时,请求会发送到 https://game-api.test.k-id.com 的测试环境。此环境旨在模拟实时系统,但使用模拟数据运行。
实时模式
实时模式 用于生产。使用实时模式 API 密钥时,请求会发送到 https://game-api.k-id.com 的生产环境。此环境处理真实数据并与实时系统交互。
注意:始终验证您正在为预期模式使用正确的 API 密钥和端点,以避免对生产数据的意外影响。
使用交互式 API 参考进行测试
在编写代码调用 k-ID API 之前,您可以使用文档中内置的 交互式 API 参考 直接测试端点。从 Compliance Studio 获取您的测试 API 密钥,方法是转到您产品的开发者设置页面。
设置 API 测试
-
导航到 API 参考 中的任何端点页面,例如
/age-gate/check端点。 -
选择基础 URL:将鼠标悬停在请求界面中的基础 URL 字段上以显示编辑按钮。单击编辑按钮并选择测试环境(
https://game-api.test.k-id.com/api/v1/)。 -
验证您的请求:将您的测试 API 密钥粘贴到"Bearer Token"字段中。
-
配置请求正文:根据需要修改请求正文值。对于测试,使用:
{
"jurisdiction": "US-CA",
"dateOfBirth": "2005-04-15"
} -
发送请求:单击"发送 API 请求"以完成 API 调用。
-
查看响应:响应显示在请求界面下方,显示 API 对您请求的响应。
您现在已经成功调用了 k-ID!有关使用交互式参考的更多详细信息,请参阅 交互式参考 指南。
测试可信成人同意
要在 Family Connect 中查看父母体验,您需要创建一个同意挑战。为此,使用交互式参考再次调用 /age-gate/check,这次使用低于美国司法管辖区数字同意年龄的儿童年龄。
使用:
{
"jurisdiction": "US-CA",
"dateOfBirth": "2015-04-15"
}
这会产生如下响应:
{
"challenge": {
"challengeId": "<guid>",
"childLiteAccessEnabled": false,
"oneTimePassword": "<one time password>",
"type": "CHALLENGE_PARENTAL_CONSENT",
"url": "https://family.k-id.com/authorize?otp=<one time password>"
},
"status": "CHALLENGE"
}
然后您可以在浏览器中导航到 url 字段中的 URL。系统会要求您提供电子邮件地址,然后您会收到一封包含指向 Family Connect 链接的电子邮件,您可以在那里授予玩游戏的同意。在浏览器中完成同意流程后,您可以使用之前提供的 challengeId 字段调用 challenge/get-status API。响应是:
{
"approverEmail": "email@example.com",
"sessionId": "<guid>",
"status": "PASS"
}
您现在已经成功创建了 k-ID Session!您可以通过将 sessionId 字段作为参数提供给 /session/get 来查看它。
{
"ageStatus": "DIGITAL_MINOR",
"dateOfBirth": "2015-04-15",
"etag": "<guid>",
"jurisdiction": "US",
"permissions": [],
"sessionId": "<guid>",
"kuid": "<guid>",
"status": "ACTIVE"
}