欧意API接口设置：权限与安全认证指南 (15-30字)

Python示例：

以下代码展示了如何使用Python安全地从环境变量中获取OKX API密钥、密钥和密码，用于后续的API调用。

import os

api_key = os.environ.get("OKX_API_KEY")

secret_key = os.environ.get("OKX_SECRET_KEY")

passphrase = os.environ.get("OKX_PASSPHRASE")

说明：

• os.environ.get() 方法用于从操作系统环境变量中检索指定变量的值。 使用环境变量是一种安全的实践，可以避免将敏感信息（如API密钥）直接硬编码到您的代码中。
• 如果环境变量未设置， os.environ.get() 将返回 None 。在实际应用中，您应该添加错误处理机制来检查这些值是否已成功获取，并在缺失时采取适当的措施，例如抛出异常或使用默认值。
• 请确保在使用API密钥和密钥之前，对其进行适当的验证，以防止潜在的安全风险。

操作步骤：

• 设置环境变量： 在您的操作系统中设置相应的环境变量，例如：

  • Linux/macOS: 在终端中使用 export 命令设置，例如： export OKX_API_KEY="YOUR_API_KEY" 。 也可以将这些命令添加到您的 shell 配置文件（例如 .bashrc 或 .zshrc ）中，以便在每次启动终端时自动设置。
  • Windows: 通过 "系统属性" -> "高级" -> "环境变量" 来设置用户或系统环境变量。

Python示例：

以下Python代码展示了如何使用 hashlib 、 hmac 和 base64 库生成符合特定交易所（例如OKX）API要求的签名，用于安全地进行身份验证和授权。

import hashlib
import hmac
import base64
import time
import os

# 获取当前时间戳，通常用于防止重放攻击。时间戳必须是字符串类型。
timestamp = str(int(time.time()))

# 定义HTTP请求方法，常见的有GET、POST、PUT、DELETE等。
method = "GET"

# API请求路径，不包含域名部分，例如"/api/v5/account/balance"。
request_path = "/api/v5/account/balance"

# 请求体，如果是GET请求，则通常为空字符串。对于POST或PUT请求，则包含JSON格式的数据。
request_body = "" # 如果是 GET 请求，则为空字符串

# 将时间戳、请求方法、请求路径和请求体组合成一个字符串，用于后续的哈希计算。
prehash = timestamp + method + request_path + request_body

# 从环境变量中获取密钥。强烈建议不要将密钥硬编码在代码中。密钥通常由交易所提供。
secret_key = os.environ.get("OKX_SECRET_KEY").encode('utf-8')

# 将prehash字符串编码为UTF-8字节串。
message = prehash.encode('utf-8')

# 使用HMAC-SHA256算法计算签名。HMAC算法需要一个密钥和一个消息作为输入。
signature = hmac.new(secret_key, message, digestmod=hashlib.sha256).digest()

# 将签名进行Base64编码，以便在HTTP请求头中传递。
signature = base64.b64encode(signature).decode()

• OK-ACCESS-KEY： API Key。
• OK-ACCESS-SIGN： 计算出的签名。
• OK-ACCESS-TIMESTAMP： 时间戳。
• OK-ACCESS-PASSPHRASE： Passphrase。

• Python示例 (使用requests库):

  本示例演示如何使用 Python 的 requests 库与 OKX API 进行交互，获取账户余额信息。为了安全地访问 API，需要生成一个签名，该签名基于您的 API 密钥、密钥和请求信息。

  导入必要的 Python 库：

  • requests ：用于发送 HTTP 请求。
  • os ：用于访问环境变量，存储敏感信息如 API 密钥。
  • time ：用于生成时间戳。
  • hashlib ：提供哈希算法，用于创建签名。
  • hmac ：用于消息认证码的算法。
  • base64 ：用于编码签名。

  import requests
  import os
  import time
  import hashlib
  import hmac
  import base64
  

  接下来，定义一个函数 generate_signature ，该函数负责生成请求签名。签名是 OKX API 验证请求来源的关键。函数接收以下参数：

  • timestamp ：请求的时间戳。
  • method ：HTTP 请求方法 (例如 "GET", "POST", "PUT", "DELETE")。
  • request_path ：API 端点路径 (例如 "/api/v5/account/balance")。
  • request_body ：请求体 (对于 GET 请求，通常为空字符串)。
  • secret_key ：您的 OKX 密钥。

  签名生成过程如下：

  1. 将时间戳、HTTP 方法、请求路径和请求体连接成一个字符串 prehash 。
  2. 使用 UTF-8 编码密钥和 prehash 字符串。
  3. 使用 HMAC-SHA256 算法，以编码后的密钥作为密钥，编码后的 prehash 字符串作为消息，计算哈希值。
  4. 将哈希值进行 Base64 编码，然后解码成字符串。

  def generate_signature(timestamp, method, request_path, request_body, secret_key):
      prehash = timestamp + method + request_path + request_body
      secret_key = secret_key.encode('utf-8')
      message = prehash.encode('utf-8')
      signature = hmac.new(secret_key, message, digestmod=hashlib.sha256).digest()
      signature = base64.b64encode(signature).decode()
      return signature
  

  从环境变量中获取 API 密钥、密钥和 passphrase。建议使用环境变量存储敏感信息，避免硬编码在代码中。 os.environ.get() 函数用于从环境变量中读取值。

  api_key = os.environ.get("OKX_API_KEY")
  secret_key = os.environ.get("OKX_SECRET_KEY")
  passphrase = os.environ.get("OKX_PASSPHRASE")
  

  设置请求参数：

  • timestamp ：当前时间戳（秒级别）。
  • method ：HTTP 方法，这里使用 "GET"。
  • request_path ：API 端点，这里是获取账户余额的端点。
  • request_body ：请求体，对于 GET 请求为空字符串。

  timestamp = str(int(time.time()))
  method = "GET"
  request_path = "/api/v5/account/balance"
  request_body = ""
  

  调用 generate_signature 函数生成签名。

  signature = generate_signature(timestamp, method, request_path, request_body, secret_key)
  

  构造 HTTP 请求头。请求头必须包含以下字段：

  • OK-ACCESS-KEY ：您的 API 密钥。
  • OK-ACCESS-SIGN ：生成的签名。
  • OK-ACCESS-TIMESTAMP ：时间戳。
  • OK-ACCESS-PASSPHRASE ：您的 passphrase。

  headers = {
      "OK-ACCESS-KEY": api_key,
      "OK-ACCESS-SIGN": signature,
      "OK-ACCESS-TIMESTAMP": timestamp,
      "OK-ACCESS-PASSPHRASE": passphrase
  }
  

  构建完整的 API URL，然后使用 requests.get() 函数发送 GET 请求。替换 https://www.okx.com 为实际的 OKX API 域名（如果需要）。

  url = "https://www.okx.com" + request_path # replace with OKX's API endpoint
  response = requests.get(url, headers=headers)
  print(response.text)
  

  打印响应内容。 response.text 包含了 API 返回的 JSON 数据，包含了您的账户余额信息。您可以根据需要解析 JSON 数据，提取所需的信息。

  发送API请求： 使用HTTP客户端发送API请求，并将请求头添加到请求中。

四、IP地址白名单限制 (可选，强烈推荐)

为了显著增强您的API密钥的安全性，欧易（OKX）平台提供IP地址白名单限制功能。通过配置，您可以限定仅允许来自特定IP地址或IP地址段的请求访问您的API接口，从而有效防止未经授权的访问和潜在的安全风险。强烈建议您启用此功能。

1. 理解IP地址白名单： IP地址白名单是一种安全机制，它允许您指定一组受信任的IP地址。只有从这些IP地址发起的API请求才会被欧易服务器接受和处理。来自其他IP地址的请求将被自动拒绝，从而大大降低了您的账户被非法入侵的风险。
2. 配置IP地址白名单： 在您的欧易账户中找到API管理页面。通常，您需要进入“账户安全”或类似的设置部分。在API密钥管理页面，您会找到IP地址白名单的配置选项。
3. 添加允许的IP地址： 您可以输入单个IP地址或IP地址段。IP地址段可以使用CIDR（Classless Inter-Domain Routing）表示法，例如， 192.168.1.0/24 表示从 192.168.1.0 到 192.168.1.255 的整个IP地址段。请务必仔细核对您输入的IP地址，确保它们是您信任的IP地址。
4. 注意事项：
   • 确保您将用于API请求的服务器或设备的IP地址添加到白名单中。
   • 如果您使用动态IP地址，请考虑使用IP地址段或定期更新白名单。
   • 避免将 0.0.0.0/0 添加到白名单，因为这会允许任何IP地址访问您的API接口，从而失去安全防护作用。
   • 如果您的IP地址发生变化，请立即更新IP地址白名单。
   • 务必测试您的配置，确保API请求可以从白名单中的IP地址成功发送。
在API管理页面设置： 在欧意的API管理页面，找到IP地址限制选项。