跳到主要内容

交互式参考

k-ID API 参考包括交互式代码示例，允许您直接从文档测试 API 端点。每个端点页面都包括代码示例和可用于进行实时 API 调用的请求界面。

Interactive reference interface

交互式请求界面​

每个端点页面在"请求"部分都包括一个交互式请求界面。此界面允许您：

  1. 选择基础 URL：将鼠标悬停在基础 URL 字段上以显示编辑按钮。单击编辑按钮打开包含可用基础 URL 的下拉菜单：

    • 实时：https://game-api.k-id.com/api/v1/
    • 测试：https://game-api.test.k-id.com/api/v1/

  2. 验证您的请求：将您的 API 密钥粘贴到"Bearer Token"字段中

    • 您可以从 Compliance Studio 获取您的 API 密钥
    • 确保您使用与所选环境（测试或实时）对应的正确 API 密钥

  3. 配置请求正文：正文字段包含带有示例值的示例请求

    • 您可以修改请求正文中的任何值以匹配您的需求
    • 必需字段在端点文档中指示

  4. 发送请求：单击"发送 API 请求"以完成 API 调用

  5. 查看响应：响应显示在请求界面下方，显示 API 对您请求的响应

代码示例​

每个端点页面还在右上角包含代码示例，显示如何使用各种编程语言和工具进行请求。这些示例仅供参考，可以复制到您自己的代码中使用。

最佳实践​

  • 使用测试环境进行 API 实验
  • 永远不要将 API 密钥提交到版本控制 - 而是使用环境变量
  • 仔细审查响应以了解 API 的行为
  • 检查错误响应以了解如果请求失败出了什么问题

有关身份验证和 API 密钥的更多信息，请参阅 身份验证。