# 获取API Key

操作路径

登录【商户后台】->进入【开发者中心】->点击【API Key】菜单->编辑 ->点击【创建】

# 配置说明

  • 每个 API Key 都配有独立配置页,可绑定 固定 IP 地址
  • 若将 IP 设置为 0.0.0.0,表示不做 IP 限制任何来源 IP 都可访问接口。
  • 建议为不同业务场景/系统创建 不同的 API Key,以实现权限隔离与管理灵活性。

# 注意事项

  • Access Key 和 Secret Key 是您的身份凭证,请妥善保管,不要泄露给第三方。
  • Secret Key 仅在创建时展示一次,请务必当场保存好。
  • 若您遗忘 Secret Key,请登录后台回收当前密钥对,并重新申请新的 API Key。

# 创建 API Key

  1. 选择是否开启调试模式
    1. 开启后,如接口调用失败,系统将提供标准化的错误提示及日志地址,方便问题排查。
    2. Tips:为保障生产环境安全,测试完成后请及时关闭调试模式,防止敏感信息泄露。
  2. 选择 API Key 权限范围
    1. 根据业务需求选择相应权限(如:只读、交易、回调权限等)。
  3. 输入白名单地址
    1. 可填写允许访问该 API Key 的 IP
    2. 支持多个地址,用英文逗号 , 分隔。 示例:192.168.1.1,10.0.0.1,www.example.com
    3. 若填入 0.0.0.0,表示不限制 IP,任意来源可访问不推荐用于生产环境)。
  4. 点击创建 API Key
    1. 创建成功后,系统将生成一组 Access Key 和 Secret Key。
    2. ⚠️ 注意:Secret Key 仅在生成时展示一次,请务必妥善保存。 若遗忘 Secret Key,请通过后台【回收】该密钥对并重新申请新的 Key。

img

# 编辑API Key

  • 点击 编辑按钮 可对以下内容进行调整:
    • 开启 / 关闭 【调试模式】
    • 修改 API Key 权限
    • 更新 白名单地址
  • 修改完成后,点击 保存 即可应用更改。

请注意:API Key 创建或编辑后约需 90 秒生效。 在此期间调用接口可能仍使用旧配置,请耐心等待再进行请求验证。

img

# 使用APIKey

当前 API Key 需在请求的 Header 中添加以下参数:

参数名 参数说明 类型 是否必填
access_key API Key 访问密钥(如:TPhoa7ZQ) String
timestamp 毫秒级时间戳(13 位,如:1679669488472) String
nonce UUID(36 位,如:02f7a04f-53cc-47d4-bb3f-fae69dab49ac) 五部分组成:8-4-4-4-12 位,用 - 分隔 String
sign 签名字符串(如:GXx2wYUD6UVr+zcmeCSFFPzcBLA=) String