欧易交易所 API 密钥申请和使用教程
在加密货币交易中，API（应用程序编程接口）密钥允许您通过编程方式访问交易所的数据和功能，从而实现自动化交易、数据分析和各种定制化应用。欧易交易所（OKX）提供了一套强大的API，允许用户创建自己的交易机器人、监控市场数据以及执行其他高级操作。本文将详细介绍如何在欧易交易所申请API密钥，并提供使用这些密钥的入门指南。
1. 注册和登录欧易账户
如果您尚未拥有欧易（OKX）账户，请访问欧易官方网站（www.okx.com）进行注册。注册流程通常需要您提供有效的电子邮件地址或手机号码，并设置一个安全的密码。强烈建议使用包含大小写字母、数字和特殊字符的复杂密码，并启用双因素认证（2FA）以增强账户安全性。完成注册后，您需要进行身份验证（Know Your Customer，KYC），以解锁完整的API访问权限和提升账户安全级别。欧易通常提供多个KYC验证等级，不同等级对应不同的API权限和每日/每月交易限额。提交所需的身份证明文件，例如身份证、护照或驾照，并根据平台指示完成人脸识别等验证步骤。通过更高等级的KYC验证通常可以解锁更高级别的API功能，例如更高频率的请求限制和更大的交易量。
2. 开启API功能和创建API密钥
登录您的欧易账户后，严格遵循以下详细步骤操作，以确保API密钥的安全性和正确配置：
- 导航至API管理页面： 将鼠标悬停在欧易交易平台页面右上角代表用户身份的头像上。这将触发一个下拉菜单，其中包含多个选项。从这些选项中，精确选择“API”选项。此操作将引导您至专门用于管理API密钥的页面。务必仔细辨认头像图标，并确保下拉菜单完整展开，以便找到正确的“API”入口。
- 创建新的API密钥： 在API管理页面，寻找一个明确标记为“创建API密钥”或类似文字的按钮。该按钮通常位于页面的显著位置，方便用户快速启动创建API密钥的流程。点击此按钮，系统将引导您进入一个表单，您需要在其中填写有关新API密钥的必要信息。
-
填写API密钥信息：
在API密钥创建表单中，您需要提供以下关键信息，这些信息对于API密钥的功能和安全性至关重要：
- API密钥名称： 为您的API密钥分配一个清晰且具有描述性的名称。建议使用能够反映API密钥用途的名称，例如“我的量化交易机器人”或“市场数据采集”。良好的命名约定可以帮助您轻松识别和管理多个API密钥，避免混淆。
- 绑定IP地址（可选但强烈推荐）： 为了显著增强API密钥的安全性，强烈建议您将API密钥绑定到特定的IP地址。此举意味着只有来自预先授权的IP地址的请求才能够成功使用该API密钥。对于生产环境或任何涉及资金操作的API密钥，绑定IP地址是必不可少的安全措施。如果您不确定您的固定公网IP地址，或者需要在不同的网络位置使用API密钥，您可以暂时将其留空。但是，一旦确定了稳定的IP地址，请立即进行绑定。务必注意，使用公共Wi-Fi等不安全的网络环境时，请谨慎使用API密钥。
-
交易权限：
这是配置API密钥时最重要的设置之一。欧易交易所允许您为API密钥分配不同的权限级别，从而精确控制API密钥的功能。常见的权限选项包括：
- 只读： 此权限级别允许API密钥访问您的账户信息（例如余额、交易历史）以及实时的市场数据（例如价格、交易量）。但是，拥有只读权限的API密钥无法执行任何交易操作。此权限适用于数据分析、监控等不需要进行资金操作的场景。
- 交易： 此权限级别允许API密钥执行交易操作，例如下单、撤单、修改订单等。拥有此权限的API密钥可以代表您进行自动交易。在授予此权限时，务必谨慎评估使用该API密钥的应用程序或交易机器人的安全性。
- 提现： 此权限级别允许API密钥提取您的账户资金。 强烈建议您永远不要启用此权限，除非您对使用该API密钥的应用程序或个人具有绝对的信任。 即使在最信任的情况下，也应尽量避免授予提现权限，以最大限度地降低资金被盗的风险。如果确实需要提现功能，请考虑使用其他更安全的提现方式。
- 资金密码： 在某些情况下，出于安全考虑，创建API密钥的过程可能需要您输入资金密码进行身份验证。资金密码是您在欧易账户中设置的用于保护资金安全的密码。输入正确的资金密码是创建API密钥的必要条件，以确保只有账户所有者才能创建具有交易或提现权限的API密钥。
- 确认并创建API密钥： 在您填写完所有必要的信息后，请务必仔细检查所有设置，特别是权限设置和绑定的IP地址。确保所有设置都符合您的预期，并且没有疏忽或错误。然后，点击“确认”或“创建”按钮，以提交您的API密钥创建请求。
- 保存API密钥： 成功创建API密钥后，系统将向您显示两个关键的字符串：您的API密钥（API Key）和密钥（Secret Key）。 务必立即采取措施，安全地存储您的Secret Key，并且绝对不要将其泄露给任何第三方。 Secret Key是访问您的欧易账户和执行操作的关键凭证，一旦泄露，可能导致您的资金遭受损失。欧易交易所通常只会显示一次Secret Key，之后您将无法再次查看。如果您丢失了Secret Key，您将需要立即删除现有的API密钥，并创建一个新的API密钥。为了确保安全，建议您将Secret Key保存在加密的密码管理器中，并定期更换API密钥。强烈建议不要将Secret Key存储在未加密的文本文件或电子邮件中。
3. 理解API密钥的组成
每个API密钥是访问欧易交易所API接口的关键凭证，由两部分组成，共同保障账户安全和数据访问控制：
- API Key（公钥）： 相当于您的用户名或账户标识符，用于唯一标识您的账户。它类似于公共标识符，用于初步识别API请求的来源。您可以公开分享API Key而无需担心安全问题，因为它本身不具备授权能力。
- Secret Key（私钥）： 相当于您的密码，或者更准确地说，是您的数字签名。它用于验证您的身份，证明API请求确实是由您授权发起的。Secret Key必须严格保密，切勿泄露给任何人。泄露Secret Key可能导致您的账户被盗用，资金遭受损失。
在使用欧易API时，您需要同时提供API Key和Secret Key。API Key让欧易交易所知道请求来自哪个账户，而Secret Key用于生成签名，并由交易所验证签名的有效性，从而确认您的身份并授权您的请求。 只有当API Key和通过Secret Key生成的签名都正确无误时，欧易交易所才会处理您的API请求。
4. 使用API密钥进行身份验证
欧易API采用基于HMAC SHA256的签名认证机制，确保交易安全。要使用API，您必须使用您的Secret Key对每个请求进行签名，并将签名以及其他必要的认证信息添加到HTTP请求头中。详细步骤如下：
-
构建预签名字符串：
根据API文档要求，构建用于签名的字符串。 这通常包括HTTP请求方法（如GET或POST）、API端点路径以及请求参数。对于GET请求，参数应按照字母顺序排列，并作为查询字符串附加到URL；对于POST请求，参数通常位于请求体中。务必仔细检查欧易API的文档，以确定确切的参数排序和连接规则。例如：
GET /api/v5/account/balance?ccy=BTC&instId=BTC-USDT。 - 计算HMAC SHA256签名： 使用您的Secret Key作为密钥，采用HMAC SHA256算法对先前构建的预签名字符串进行哈希计算。 此过程会生成一个唯一的签名，用于验证请求的真实性和完整性。Secret Key必须妥善保管，切勿泄露。计算签名时，请确保使用正确的字符编码（通常为UTF-8）。
-
添加请求头：
将计算出的签名添加到名为
OK-ACCESS-SIGN的HTTP请求头中。 除了签名之外，还需要添加以下请求头：-
OK-ACCESS-KEY: 您的API Key，用于标识您的账户。 -
OK-ACCESS-TIMESTAMP: 当前的Unix时间戳（以秒为单位）。 此时间戳用于防止重放攻击，确保请求在有效的时间窗口内被处理。服务器通常会拒绝时间戳过旧的请求。 -
OK-ACCESS-PASSPHRASE: 在创建API密钥时设置的密码短语。 如果您在创建API密钥时没有设置密码短语，则此值应为空字符串。 密码短语增加了额外的安全层。
-
- 发送API请求： 将所有必要的请求头添加到您的HTTP请求中，然后将请求发送到相应的欧易API端点。 确保使用正确的HTTP方法（GET、POST等）和内容类型。 在发送请求之前，最好先使用API测试工具（如Postman）进行测试，以验证请求是否正确构造。
以下是一个使用Python代码生成签名的示例：
import hashlib
import hmac
import time
def generate_signature(timestamp, method, request_path, body, secret_key):
message = str(timestamp) + method + request_path + body
mac = hmac.new(bytes(secret_key, encoding='utf8'), bytes(message, encoding='utf-8'), digestmod=hashlib.sha256)
d = mac.digest()
return d.hex()
示例数据
在进行加密货币API交互时，以下是一些关键参数的示例值，请务必替换成您自己的真实凭据，并妥善保管。
api_key = "YOUR_API_KEY"
secret_key = "YOUR_SECRET_KEY"
passphrase = "YOUR_PASSPHRASE"
# 如果您在交易所设置了passphrase，则需要提供。如果未设置，请将其设置为空字符串。passphrase增加了账户安全性，建议启用。
timestamp = str(int(time.time()))
# 时间戳对于生成签名至关重要，通常是自Unix纪元（1970年1月1日00:00:00 UTC）以来的秒数。请确保时间戳的准确性，并考虑时区差异。
method = "GET"
# HTTP请求方法，常见的有GET（用于获取数据）和POST（用于提交数据）。其他方法如PUT、DELETE等在API中也可能用到。请根据API文档选择正确的方法。
request_path = "/api/v5/account/balance"
# API请求的路径，指向特定的API端点。不同的路径对应不同的功能，如查询账户余额、下单、撤单等。务必仔细阅读API文档，确保请求路径的正确性。版本号（如v5）也需要注意。
body = ""
# HTTP请求的主体内容。对于GET请求，通常body为空。对于POST、PUT等请求，body通常包含JSON格式的数据，用于传递参数。
计算签名
在加密货币交易和API交互中，安全至关重要。为了确保请求的完整性和真实性，通常需要计算并附加签名。签名本质上是请求数据的数字指纹，接收方可以使用它来验证请求是否被篡改以及是否来自授权方。
签名计算的核心在于使用特定的算法（例如 HMAC-SHA256）将请求的各个部分组合起来，并使用只有发送方和接收方知道的密钥进行加密。常见的签名计算参数包括：
- timestamp (时间戳): Unix 时间戳，表示请求发出的时间。用于防止重放攻击。
- method (方法): HTTP 请求方法 (例如：GET, POST, PUT, DELETE)。
- request_path (请求路径): API 端点的 URL 路径 (例如：/api/v1/orders)。
- body (请求体): 请求体的内容，通常是 JSON 格式的数据。如果请求没有请求体，则为空字符串。
- secret_key (密钥): 只有发送方和接收方知道的私钥。
计算签名的伪代码如下：
signature = generate_signature(timestamp, method, request_path, body, secret_key)
其中
generate_signature
函数的具体实现会根据不同的平台和API而有所不同，但其基本原理都是相同的：将上述参数按照预定的规则组合并进行哈希运算，然后使用密钥进行加密。 生成的
signature
将作为请求头或请求参数的一部分发送给服务器，服务器会使用相同的参数和密钥重新计算签名，并与接收到的签名进行比较。如果两个签名匹配，则表明请求是有效的。如果不匹配，则表明请求可能已被篡改或不是来自授权方。
注意： 密钥的安全性至关重要。绝不能将密钥泄露给未经授权的第三方，并且建议定期更换密钥。
构造请求头
在与交易所的API交互时，构建正确的请求头至关重要。这些头部信息用于验证您的身份，并确保请求的安全性与完整性。以下是构建请求头的示例，其中包含了必要的身份验证和请求类型声明。
headers = {
"OK-ACCESS-KEY": api_key,
# 您的API密钥，用于识别您的账户。务必妥善保管此密钥。
"OK-ACCESS-SIGN": signature,
# 请求的签名，使用您的私钥和请求数据生成，用于验证请求的完整性，防止篡改。
"OK-ACCESS-TIMESTAMP": timestamp,
# 请求的时间戳，通常是Unix时间戳，用于防止重放攻击。
"OK-ACCESS-PASSPHRASE": passphrase,
# 您的Passphrase，通常在创建API密钥时设置，用于增加安全性。
"Content-Type": "application/" # 某些POST请求需要指定Content-Type，例如application/，表示请求体是JSON格式。
}
print(headers)
重要提示：
-
api_key,signature,timestamp, 和passphrase是变量，您需要根据您的API密钥和请求内容生成这些值。 - 签名算法和数据格式可能因交易所而异，请参考交易所的API文档。
- 为了安全起见，切勿将您的API密钥和Passphrase存储在代码中，建议使用环境变量或配置文件。
- 对于不同的API端点，可能需要不同的请求头参数，请仔细阅读API文档。
-
如果需要发送JSON格式的数据，请确保将数据序列化为JSON字符串，并设置
Content-Type为application/。
5. 常见的API端点和功能
欧易API提供了丰富的端点，使开发者能够访问实时的市场数据和执行交易操作。这些端点覆盖了账户管理、市场数据检索、交易执行以及历史数据查询等多个关键领域。下面列出一些常用的API端点，并对其功能进行更详细的描述：
- /api/v5/account/balance： 获取账户余额。该端点允许用户查询其在欧易交易所各个账户中的资产余额。返回的信息通常包括可用余额、冻结余额以及总余额，并按不同币种进行区分。这对于用户监控其资产状态至关重要。可以通过指定币种来查询特定币种的余额信息。
- /api/v5/market/tickers： 获取市场行情数据。该端点提供各种交易对的实时市场行情信息，例如最新成交价、最高价、最低价、成交量等。开发者可以利用这些数据构建交易策略、进行市场分析和风险管理。可以通过参数指定需要查询的交易对。
- /api/v5/trade/order： 下单。该端点允许用户提交买入或卖出订单。下单时需要指定交易对、订单类型（例如限价单、市价单）、数量和价格等参数。成功下单后，API会返回订单ID，用户可以使用该ID查询订单状态。支持的订单类型包括限价单（limit order）、市价单(market order)、止损单(stop order)等。
- /api/v5/trade/cancel-order： 撤单。使用该端点可以取消尚未成交的订单。撤单时需要提供要取消的订单ID。取消订单有助于用户管理其交易风险并及时调整交易策略。
- /api/v5/account/bills： 查询账单历史记录。该端点允许用户查询其账户的账单历史记录，包括充值、提现、交易等各种类型的账单。账单记录包含时间戳、交易类型、金额等详细信息。用户可以通过这些历史记录进行财务分析和审计。可以根据账单类型和时间范围进行过滤。
完整的API文档包含了每个端点的详细参数说明、请求示例、返回数据结构以及错误码解释。请务必参考欧易官方网站上的最新API文档，以获取最准确和全面的信息，以便更好地理解和使用欧易API，并避免潜在的错误。
6. 安全注意事项
- 保护您的Secret Key： 绝对不要将您的Secret Key（私钥）泄露给任何人。Secret Key 是访问和控制您账户的关键，任何获得它的人都可以完全控制您的资金和交易活动。请务必将其存储在安全的地方，并像对待银行密码一样谨慎保管。强烈建议使用硬件钱包或加密软件进行安全存储。
- 使用IP绑定： 尽可能将您的API密钥绑定到特定的IP地址。这意味着只有来自特定IP地址的请求才能使用该API密钥。通过限制API密钥的使用范围，即使密钥泄露，攻击者也难以从其他IP地址进行非法操作，从而有效降低潜在的安全风险。务必仔细核对您允许的IP地址列表，并定期审查。
- 限制交易权限： 只授予API密钥必要的交易权限。如果您的API密钥仅用于读取市场数据，则不要授予其进行交易或提款的权限。最小权限原则是保障账户安全的关键。仔细检查API密钥的权限设置，并根据实际需求进行调整。
- 定期更换API密钥： 为了提高安全性，建议您定期更换API密钥。定期更换可以降低密钥泄露后被利用的风险。设置提醒，定期生成新的API密钥并撤销旧的密钥。这将有效防止长期暴露的密钥被恶意利用。
- 监控API使用情况： 定期检查您的API使用情况，包括请求频率、交易记录和IP地址等，以确保没有异常活动。通过监控API使用情况，您可以及时发现潜在的安全威胁，例如未经授权的交易或异常的请求模式。设置警报系统，以便在检测到异常活动时立即收到通知。
通过遵循这些安全注意事项，您可以最大限度地保护您的欧易账户和资金安全，降低被攻击的风险，并确保您的加密货币资产的安全。
