尝试API

在尝试编写代码调用k-ID API之前，您可以使用您的API密钥和API文档自行测试。从发布者门户获取API密钥。

在API文档页面，找到按钮，点击它并输入您在开发者仪表板中的k-ID产品的API密钥。

现在打开/age-gate/check API部分，点击Try it out按钮。

然后点击Execute按钮。

在下面的部分中，您将看到使用以下请求体进行的/age-gate/check调用的成功结果：

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

作为POST请求体。

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

尝试家庭门户

要在家庭门户中查看家长体验，您需要创建一个同意挑战。为此，再次使用Execute按钮调用/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。系统将要求您输入电子邮件地址，然后您将收到一封带有家庭门户链接的电子邮件，您可以在其中授予玩游戏的同意。完成浏览器中的同意流程后，您可以使用上述challengeId字段调用challenge/await 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>",
  "status": "ACTIVE"
}