API 访问和用法#
在开始使用 DEX API 之前，你需要先在开发者管理平台创建项目并生成 API key。详细的步骤和相关资源请参考这里。
鉴权#
所有对 API 发起访问的请求都需要包括下面信息来进行身份认证。
- OK-ACCESS-KEY ： API key
- OK-ACCESS-TIMESTAMP ：发起请求的时间 (UTC) 。ISO 格式，如：2020-12-08T09:08:57.715Z
- OK-ACCESS-PASSPHRASE ：创建 API key 时指定的 passphrase
- OK-ACCESS-SIGN ：签名
签名步骤：
- 第一步：将 timestamp 、 method 、requestPath 、 body 拼接成一个字符串
- 第二步：以 HMAC SHA256 算法 和 secret key (在创建 API key 时生成) 对预哈希字符串 (第一步产生的结果) 进行签名
- 第三步：以 Base64 算法对签名进行编码
解释
- 例如，sign=CryptoJS.enc.Base64.stringify(CryptoJS.HmacSHA256(timestamp + 'GET' + '/api/v5/dex/aggregator/swap', SecretKey))
- 其中，timestamp 与 OK-ACCESS-TIMESTAMP 必须相同
- 其中，GET 是 method （HTTP请求方法，字母全部大写）
- 其中，/api/v5/dex/aggregator/swap 是requestPath （请求接口路径）
- 其中 body 为空。如果请求没有请求体（通常为 GET 请求），那 body 可省略
注意
- 时间戳与服务端时差不得超过 30 秒
- POST 请求需包含原始请求体参与签名计算
- Secret key 仅创建时可见，请通过安全渠道存储
遗留 API#
钱包 API、市场 API 和 DeFi API 已经被归档，我们将不再提供更新。如果你正在使用相关服务并需要查看有关的文档内容 ，请前往这里 。