跳到主要内容

创建 API Key

在使用 API 接口或部署 API Co-Signer 之前，您需要先创建一个 API Key。本文将指导您完成 API Key 的创建流程，并说明各类配置项的用途和注意事项。

通过本教程，您将了解：

  1. API Key 的用途分类；
  2. 如何创建不同用途的 API Key。

API Key 用途说明​

API Key 根据用途分为两类，不可混用：

前置条件​

使用具备 API 管理权限的账号登录 Safeheron 控制台，在左侧导航栏中进入管理 > API，打开 API Key 列表页。

创建「访问 API」用途的 API Key​

点击 “创建 API Key”，在“添加 API Key”页面完成以下配置：

  1. 用途：选择 “访问 API”。

  2. 名称：为该 API Key 设置便于识别的名称。

  3. 您的公钥：请上传您的 RSA 公钥。Safeheron 会使用该公钥验证请求签名的合法性，并使用该公钥加密响应数据。

    警告

    请确保在安全环境中生成密钥对，并妥善保管私钥，防止泄露带来的资产风险。

  4. IP 白名单：填写允许访问 API 的出口 IP（支持 IPv4/IPv6）。不在白名单内的请求将被拒绝，返回错误码 1011。

    提示

    测试团队可关闭 IP 白名单限制，允许任意来源的 IP 调试 API。

  5. 设置权限：根据业务场景选择所需权限，推荐遵循最小权限原则。

    权限说明
    读取默认权限，可访问查询类接口（如查询钱包账户、交易记录等）
    发起/取消交易（从 API 创建的钱包账户）可使用通过 API 创建的钱包账户发起交易
    发起/取消交易（从平台内创建的钱包账户）可使用通过 Safeheron Web Console 或 手机 App 创建的钱包账户发起交易
    管理钱包账户可调用钱包账户管理类接口（如添加 token、修改展示状态等）
    管理白名单可调用白名单管理接口（如添加/修改/删除白名单地址）

  6. 提交审批：点击“提交审批”后，审批任务将推送至团队成员的手机 App，审批通过后该 API Key 生效。

  7. 获取平台公钥：在 API Key 列表中，点击公钥列的 “查看” 按钮可获取 平台公钥。该公钥用于：加密 API 的请求参数、验证 API 响应数据的签名合法性。

  8. 完成

创建「部署 API Co-Signer」用途的 API Key​

在 API Key 管理页面，点击"创建 API Key" 按钮，在“添加 API Key”页面，按如下步骤配置：

  1. 用途：选择 “部署 API Co-Signer”。

  2. 名称：为该 API Key 设置便于识别的名称。

  3. IP 白名单：填写 API Co-Signer 所在服务器的出口 IP，否则 API Co-Signer 将无法正常工作。

  4. 设置 Callback URL 和公钥：

    • URL：填写 Approval Callback Service 的回调地址；
    • 公钥：上传该 Callback 服务的 RSA 公钥；
    • 跳过 Callback 配置：勾选后可跳过 Callback URL 与公钥配置。跳过后，API Co-Signer 将默认批准审批任务，不再回调。为了安全，仅允许用途为测试的团队跳过 Callback 配置，正式团队不支持。

  5. 提交审批：点击 “提交审批”，团队成员通过手机 App 审批后生效。

  6. 获取 Pairing Token：审批通过后，点击 API Key “更多”操作中的 “Pairing Token”，复制 Pairing Token，在部署 API Co-Signer 时使用。

  7. 完成

下一步​

您已成功创建 API Key，可根据用途继续下一步操作：