开发者设置

产品详情页上的开发者设置标签页包含将 k-ID 集成到产品中所需的技术配置。包括 API 密钥、Webhook 端点、目标来源和 API URL。

API 密钥

每个产品都有单独的测试和生产环境 API 密钥，使您的开发和生产流量相互隔离。

密钥类型	用途	配置来源
Test API keys	开发和测试	测试环境配置
Live API keys	生产环境	已发布的生产配置

创建密钥

1. 导航到产品的 Developer Settings 标签页。
2. 在 API Keys 部分，选择环境（Test 或 Live）。
3. 点击创建按钮并为密钥命名，例如 "Production Server" 或 "Staging Environment"。
4. 密钥生成并显示。请立即复制，因为完整密钥不会再次显示。

您可以为每个环境创建多个密钥。当不同服务或部署阶段需要各自的密钥时很有用，例如为游戏服务器和分析管道分别创建密钥。

密钥安全

API 密钥应保持在服务端，不要在客户端代码中暴露。像对待密码一样对待它们：

• 将密钥存储在环境变量或密钥管理器中
• 不要将密钥提交到源代码控制
• 不要在客户端 JavaScript、移动应用包或任何发送给终端用户的代码中包含密钥

如果密钥泄露，请立即从开发者设置页面撤销并创建新密钥。

Webhooks

Webhooks 允许 k-ID 在重要事件发生时通知您的服务器，例如质询状态变更、验证结果或会话权限更新。

配置 Webhooks

为测试和生产环境配置单独的 Webhook 端点：

1. 在 Webhooks 部分，选择环境。
2. 输入您的 Webhook URL。这是您服务器上接收来自 k-ID 的 POST 请求的端点。
3. 保存配置。

可用事件类型

Webhook 事件涵盖合规生命周期中的关键时刻：

• 质询状态变更
• 验证结果
• 验证撤销
• 家长同意授予
• 会话权限变更
• 会话删除
• 测试事件（用于验证 Webhook 设置）

每个 Webhook 传递都包含签名头，您应验证该签名以确认请求来自 k-ID。完整的 Webhook 事件参考（包括有效负载结构和签名验证），请参阅 Webhooks。

目标来源

配置客户端集成允许的来源（域名）。使用 k-ID 组件或客户端 API 时，请求会根据这些来源进行验证以防止未授权使用。

添加您的开发、预发布和生产域名。每个来源应是完整的来源 URL，例如：

• https://yourgame.com
• https://staging.yourgame.com
• http://localhost:3000（用于本地开发）

提示

记得添加集成运行的所有环境，包括本地开发 URL。不在此列表中的来源发送的请求将被拒绝。

API URL

产品详情页显示两个环境的 API 基础 URL。这些是您的服务器向 k-ID API 发出请求时使用的 URL。

环境	用途
Test API URL	开发期间与测试 API 密钥配合使用
Live API URL	生产环境中与生产 API 密钥配合使用

请使用产品开发者设置页面上显示的 URL，不要手动构建。