欧易API接口申请教程,如何使用Postman测试API密钥?

admin 欧易中心 1

📚 目录导读

  1. 欧易API接口概述
  2. API密钥申请全流程
  3. Postman环境配置详解
  4. 实战:用Postman测试API密钥
  5. 常见问题与问答(FAQ)

欧易API接口概述

对于量化交易者或开发者而言,欧易交易所下载(OKX)的API接口是实现自动化交易的核心工具,欧易API支持REST和WebSocket协议,可获取行情数据、管理账户、执行订单等,本教程将重点讲解如何申请API密钥,并使用Postman这一流行工具进行接口测试,确保密钥配置正确。

欧易API接口申请教程,如何使用Postman测试API密钥?-第1张图片-欧易交易所

核心优势:

  • 毫秒级响应,支持高频交易
  • 完整文档与社区支持
  • 安全机制:需签名验证请求

API密钥申请全流程

1 登录欧易官网并进入API管理

  1. 访问欧易官网,登录您的账户。
  2. 点击右上角头像 → “API” → “创建API密钥”。

2 填写密钥信息

  • 密钥名称:建议标注用途(如“量化策略1”)。
  • 权限设置
    • 交易权限(必须勾选,用于测试下单)
    • 提币权限(建议取消勾选,防止资产风险)
  • IP白名单:必须添加您Postman所在设备的公网IP(可百度查询IP)。

3 保存密钥

创建成功后,系统会生成两个关键字符串:

  • API Key(身份标识)
  • Secret Key(签名密钥,仅显示一次,务必截图保存)

⚠️ 若密钥丢失,需重新创建并要求原有密钥失效。


Postman环境配置详解

1 安装Postman与设置环境变量

  1. 下载并安装Postman(官网:postman.com)。
  2. 点击左侧“Environments” → 创建新环境(如“OKX API”)。
  3. 添加以下变量:
    • api_key:填入您的API Key
    • secret_key:填入Secret Key
    • passphrase:您在创建时设置的密码(若未设置,留空)
    • base_urlhttps://www.okx.com(注意欧易国际站域名,请以实际为准)

2 导入欧易API集合(可选)

在Postman中点击“Import” → 选择欧易官方API文档的JSON文件(可从GitHub下载),快速加载所有接口。


实战:用Postman测试API密钥

1 获取账户余额(GET请求)

目标接口/api/v5/account/balance
步骤:

  1. 在Postman中新建请求,输入URL:{{base_url}}/api/v5/account/balance
  2. 设置Headers:
    • OK-ACCESS-KEY: {{api_key}}
    • OK-ACCESS-SIGN: 需手动生成签名(见下方计算)
    • OK-ACCESS-TIMESTAMP: 使用Unix时间戳
    • OK-ACCESS-PASSPHRASE: {{passphrase}}

签名生成方法(Pre-request Script):

const timestamp = new Date().toISOString();
const method = 'GET';
const path = '/api/v5/account/balance';
const body = ''; // GET请求无需Body
const signString = timestamp + method + path + body;
const sign = CryptoJS.HmacSHA256(signString, pm.environment.get('secret_key')).toString(CryptoJS.enc.Hex);
pm.environment.set('timestamp', timestamp);
pm.environment.set('sign', sign);
  1. 发送请求:若返回{"code":"0","data":[{"totalEq":"100.00"}]},则密钥配置成功。

2 测试下单(POST请求)

目标接口/api/v5/trade/order
请求体示例:

{
  "instId": "BTC-USDT",
  "tdMode": "cash",
  "side": "buy",
  "ordType": "limit",
  "sz": "0.001",
  "px": "30000"
}

注意:此操作会真实下单,建议使用小额测试。


常见问题与问答(FAQ)

Q1:为什么我请求时报错“Invalid Permission”?
A:检查API密钥权限是否勾选了“交易”,或者IP白名单未添加,建议在欧易交易所下载的API管理页面重新编辑权限。

Q2:Postman签名计算总出错怎么办?
A:使用官方测试工具验证签名,可将methodpathbody与您脚本中的变量比对,并确保secret_key正确(注意大小写)。

Q3:能否只读行情不交易?
A:可以,创建API时选择“只读”权限,但需注意隔离后的接口限制(如不能获取账户余额)。

Q4:测试时提示“Signature not matched”?
A:常见原因:时间戳未用ISO格式、Body字符串未去除换行符(应使用JSON.stringify),或passphrase未设置,试运行欧易API官方示例

Q5:本教程支持欧易国际站还是国内站?
A:本教程基于欧易国际站,但国内用户可通过技术手段访问欧易交易所下载,域名以实际为准,推荐使用oe-okor.com.cn获取最新地址。


延伸阅读: 完成密钥测试后,您可进一步编写Python脚本,结合ccxt库实现全自动交易策略,更多欧易API接口详情(如K线数据、持仓查询)请参考官方文档

标签: 欧易API Postman测试

抱歉,评论功能暂时关闭!