跳到主要内容

尝试 API

在编写代码调用 k-ID API 之前，您可以使用您的 API 密钥和 API 文档自行测试。从 厂商门户获取测试 API 密钥，并进入所选产品的 开发者设置 页面，路径为 /products/[productId]/developer。

厂商仪表板

测试模式与在线模式​

测试模式​

测试模式 测试模式 允许开发者测试集成，而不会影响真实数据或生产系统。使用 测试模式 API 密钥时，请求会发送到测试环境 https://game-api.test.k-id.com 此环境旨在模拟在线系统，但使用的是模拟或沙盒数据。

在线模式​

在线模式 在线模式 用于生产环境。使用 在线模式 API 密钥时，请求会发送到生产环境 https://game-api.k-id.com 此环境处理真实数据并与在线系统交互。

注意: 始终验证您正在为所需模式使用正确的 API 密钥和端点，以避免对生产数据产生意外影响。

设置 API​

在 API 文档页面中，确保您已选择测试服务器。

选择服务器

找到 授权 按钮，点击它以从 k-ID 产品的开发者仪表板中输入 API 密钥。

对话框

然后打开 /age-gate/check API 部分，并点击 Try it out 按钮。

尝试操作

接着点击 Execute 按钮。

执行操作

在下方部分，您将看到使用以下内容作为请求体的 /age-gate/check 调用成功结果：

{
    "jurisdiction": "US-CA",
    "dateOfBirth": "2005-04-15"
}

作为请求体：

尝试结果

您现在已经成功调用了 k-ID！

尝试家庭门户​

要在家庭门户中体验家长界面，您需要创建一个同意挑战。为此，请再次调用 /age-gate/check，这次使用 Execute 按钮，并输入低于美国数字同意年龄的儿童年龄。

使用以下内容：

{
    "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 字段中的链接。系统会要求您输入电子邮件地址，随后您会收到一封带有链接的邮件，进入家庭门户，您可以在其中授予游戏访问同意。在浏览器中完成同意流程后，您可以使用上述challengeId字段调用challenge/awaitAPI。响应内容如下：

{
    "approverEmail": "email@example.com",
    "sessionId": "<guid>",
    "status": "PASS"
}

您现在已成功创建一个 k-IDSession! 您可以通过将sessionId字段作为参数提供给/session/get来查看它。

{
    "ageStatus": "DIGITAL_MINOR",
    "dateOfBirth": "2015-04-15",
    "etag": "<guid>",
    "jurisdiction": "US",
    "permissions": [],
    "sessionId": "<guid>",
    "status": "ACTIVE"
}