跳转到主要内容
所有 API 请求必须通过在 x-api-key 请求头中传递 API 密钥来进行认证。

API 密钥

启润支付使用 API 密钥来认证请求。你可以在商户控制台中管理你的 API 密钥。 当前后端实现接受生产 API 密钥:
密钥类型前缀用途
生产密钥kyren_live_生产环境 — 真实付款

发送认证请求

在每个请求的 x-api-key 请求头中包含你的 API 密钥:
curl https://api.kyren.top/v1/products \
  -H "x-api-key: kyren_live_xxxxxxxxxxxxxxxxxxxx"
请妥善保管你的 API 密钥。
  • 切勿在客户端代码(JavaScript、移动应用)中暴露 API 密钥
  • 切勿将 API 密钥提交到版本控制系统
  • 在服务器上使用环境变量存储密钥
  • 如果密钥泄露,请立即重新生成

环境

环境Base URLAPI 密钥前缀
生产环境https://api.kyren.topkyren_live_
Staging由 Kyren 支持提供仅使用 Kyren 为该 Staging 环境提供的凭证
当前公开生产 API 接受 kyren_live_ 前缀的生产密钥。 商户控制台目前不提供自助创建 kyren_test_ 测试密钥。 只有在 Kyren 向你提供对应环境的 Base URL 和凭证时,才应使用 Staging 环境。

重新生成 API 密钥

如果你的 API 密钥泄露,可以在控制台中重新生成:
  1. 前往 控制台 > 开发者
  2. 点击要替换的密钥旁边的重新生成
  3. 确认操作
重新生成密钥会立即使旧密钥失效。请确保更新所有集成中的密钥。

错误响应

认证失败时,API 返回 401 Unauthorized 响应:
{
  "code": 401,
  "message": "Unauthorized"
}
常见原因:
  • 缺少 x-api-key 请求头
  • API 密钥无效或已过期
  • 使用了当前环境不接受的 API Key 前缀