创建 API Key

在使用 API 和 API Co-Signer 之前，您需要创建一个 API Key。我们将通过此教程说明如何创建 API Key ， 以及在创建过程中需要注意的事项。

通过此教程，您将了解：

1. 如何创建 API Key。
2. 获取 API Key 对应的平台公钥。

如何创建 API Key

使用具有 API 管理权限 的团队成员账户登录 Safeheron 控制台，在设置页面的 API 标签页中创建。

设置 API Key 的名称

名称是 API Key 的一个可读标记，便于您在拥有多个 API Key 的情况下进行区分。

上传您的公钥

为了保证数据传输安全，Safeheron 采用 RSA-4096 非对称加密算法对 API 接口的请求和响应数据进行加密，您需要为 API Key 生成一对 RSA 公钥与私钥，并上传公钥。Safeheron 会使用您上传的公钥对 API 响应数据进行加密。

警告

请确保在安全的环境下生成 RSA 私钥，并且妥善保管您的 RSA 私钥，泄露可能会造成资产损失。

提示

已经上传的公钥不支持修改，如需更换，可通过重新创建 API Key 来实现。

使用 OpenSSL 工具生成 RSA 公私钥方法如下：

• 生成私钥：执行以下命令后输出的 api_private.pem 文件即为私钥

  
  $ openssl genpkey -out api_private.pem -algorithm RSA -pkeyopt rsa_keygen_bits:4096
  

• 生成公钥：在同样的目录下，执行以下命令后输出的 api_public.pem 文件即为公钥

  
  $ openssl rsa -in api_private.pem -out api_public.pem -pubout
  

设置 IP 白名单

在请求 API 之前，需要把使用 API Key 发起 API 请求的公网 IP （支持 IPv4 和 IPv6）配置在白名单中。如果发起 API 请求的 IP 不在白名单中，请求将被拒绝，并返回错误码 1011。

警告

如果您需要部署 API Co-Signer ，则同样需要把 API Co-Signer 所在主机的公网 IP 配置在白名单中，否则 API Co-Signer 将无法正常工作。

提示

如果后续您的公网 IP 发生变更，或者需要使用新的公网 IP ，请及时更新 IP 白名单。IP 白名单变更后需要您的团队成员在 Safeheron 手机 App 中审核通过后方可生效。可以在 API Key 管理页面查看状态以确定修改是否生效。

设置权限

API Key 有以下权限，您可以根据自身业务需要选取所对应的权限。

权限	说明
读取	默认必选权限，可以调用所有读接口。比如，查询钱包账户，查询交易记录等
发起交易（从 API 创建的钱包账户）	拥有此权限的 API Key 可且仅可使用通过 API 创建的钱包账户发起交易
发起交易（从平台内创建的钱包账户）	拥有此权限的 API Key 可且仅可使用通过 Safeheron 手机 App 创建的钱包账户发起交易
管理钱包账户	拥有此权限，可以调用钱包账户相关的管理接口。比如：创建钱包账户，钱包账户下添加 Token ，修改钱包账户在 Safeheron 手机应用中的展示状态等
审批交易	如果您创建的 API Key 用于部署 API Co-Signer 完成自动化审批场景，则必须配置此权限和默认读取权限，不需要其他权限

警告

为了安全起见，推荐您采用最小权限原则，即仅为 API Key 配置业务场景需要的权限。

提示

变更 API Key 的权限后，需要您的团队成员在 Safeheron 手机 App 中审核通过后方可生效，可以在 API Key 管理页面查看状态以确定修改是否生效。

获取 API Key 的平台公钥

在您创建 API Key 完成后， Safeheron 会自动为此 API Key 生成一对 Safeheron 平台持有的 RSA 公私钥对，在 API Key 列表中可以获取到平台公钥以及 API Key。至此，您已经获得了：

• API Key
• 平台 RSA 公钥
• 本地生成的 RSA 私钥

在使用 API 时您需要使用以上数据。

下一步

在创建 API Key 并审核通过后，您可以尝试使用 API 创建第一个钱包。