安全管理 API 密钥

API 密钥允许应用程序访问您 BitcoinVN 账户的部分内容。请像对待密码一样保护每个密钥:任何获得密钥的人都可能查看账户信息,或执行其权限所允许的操作。

创建密钥并添加标签

创建密钥前,请确认目标主账户或 VIP 子账户处于活动状态。

然后:

  1. 打开管理 API 密钥
  2. 选择生成新密钥
  3. 将密钥复制到需要使用它的应用程序。
  4. 选择编辑
  5. 添加能够识别应用程序或用途的标签。
  6. 选择权限和可选的 IP 限制,然后保存。

请为每个应用程序使用单独的密钥,以便限制或撤销一个集成而不影响其他集成。不要在标签中包含秘密或个人信息。

选择所需的最低权限

BitcoinVN 提供两种权限级别:

  • 只读:可以查看账户数据,但不能创建订单。
  • 读写:可以查看账户数据并创建订单。

读写密钥可以使用您的账户余额创建订单,并将所得款项发送到结算目的地。任何获得此类密钥的人都可能提取您的资金。

除非应用程序确实需要创建订单,否则请使用只读访问权限。

按 IP 地址限制访问

您可以在密钥的编辑页面将其限制为特定 IP 地址:

  • 每行输入一个 IP 地址。
  • 只添加目标应用程序使用的地址。
  • 只有在应用程序无法使用固定 IP 地址时才将该字段留空。

配置 IP 限制后,来自其他地址的请求将不被接受。如果应用程序的地址发生变化,请更新列表。

通过 API 使用密钥

X-API-KEY 请求头中发送密钥:

X-API-KEY: <your-api-key>

以上占位符仅作为示例。切勿在公开代码、截图、支持消息、浏览器端应用程序、URL 或日志中放置真实密钥。

交互式 API 文档位于 bitcoinvn.io/api/doc

了解子账户上下文

API 密钥始终与创建时处于活动状态的账户关联:

  • 在主账户中创建的密钥使用主账户。
  • 子账户处于活动状态时创建的密钥使用该子账户。

在网站上切换账户不会更改现有密钥。生成密钥前,请确认活动账户。

撤销或替换密钥

打开管理 API 密钥,并在不再需要的密钥旁选择撤销。撤销后无法恢复。

如果密钥可能已经泄露:

  1. 撤销该密钥。
  2. 生成替代密钥。
  3. 应用所需权限和 IP 限制。
  4. 更新目标应用程序。

切勿将 API 密钥发送给 BitcoinVN 支持人员或任何声称代表 BitcoinVN 的人。