API Key 设置
本指南介绍如何创建和管理您的 BigONE API Key。
创建 API Key
重要:保存您的 API Secret
您的 API Secret 仅在创建 API Key 时显示一次。请立即将其保存到安全的地方。如果您丢失了 API Secret,您将需要删除该 API Key 并创建一个新的。
编辑 API Key
创建后,您可以编辑 API Key 以更新 权限范围 和 IP 白名单。但是,API Secret 在初次创建后无法再次查看。
权限范围 (Permission Scopes)
您必须根据使用场景选择合适的权限范围。每个范围授予访问特定 API 端点的权限。
| 权限名称 (英文) | 描述 |
|---|---|
| View Account Balance Information | 用于查询现货/资金账户余额和交易费率 |
| View Order Information | 用于查询订单和订单历史 |
| Create Orders | 用于下单、撤单和闪兑交易 |
| View Trade Information | 用于查询成交历史和闪兑历史 |
| View Deposit Address | 用于查看充值地址 |
| View Deposit History | 用于查看充值记录 |
| View Withdrawal History | 用于查看提现记录 |
| Execute Withdrawals | 用于发起提现 |
| Access Contract | 用于读取合约数据 |
| Create Contract | 用于创建合约订单 |
备注
如果您的 API Key 缺少端点所需的权限,您将收到代码为 10403 的 403 Permission denied 错误。
IP 白名单
为了增强安全性,建议将 IP 地址绑定到您的 API Key。每个 API Key 最多可以绑定 20 个 IP 地址或网段。
配置
- 直接输入单个 IP 地址或 IP 网段
- 多个 IP 地址用逗号分隔,例如:
192.168.1.1,192.168.1.2 - 支持 CIDR 格式的 IP 范围,例如:
192.168.1.0/24
最佳实践
- 在生产环境中始终使用 IP 白名单 — 即使您的 API 凭证泄露,这也能防止未经授权的访问
- 使用静态 IP — 如果您的服务器 IP 经常变化,请考虑使用具有静态 IP 的代理
- 仅放行必要的 IP — 只将确实需要 API 访问权限的 IP 加入白名单
安全提示
请勿泄露您的 API Key,以免造成资产损失。请像对待密码一样对待您的 API 凭证。
管理 API Key
查看您的 Key
您可以在 API 设置 页面查看所有的 API Key。对于每个 Key,您可以看到:
- API Key (公开标识符)
- 创建日期
- 权限范围
- IP 白名单状态
编辑 Key
要修改现有的 API Key:
- 前往 API 设置
- 找到您要编辑的 Key
- 点击 编辑
- 更新权限范围或 IP 白名单
- 完成 2FA 验证
删除 Key
如果您不再需要某个 API Key 或怀疑其已泄露:
- 前往 API 设置
- 找到您要删除的 Key
- 点击 删除
- 完成 2FA 验证
提示
删除 API Key 后,所有使用该 Key 的应用程序将立即失去访问权限。在删除之前,请确保更新您的应用程序。
下一步
创建 API Key 后,请前往 鉴权认证 学习如何生成用于 API 请求的签名 Token。