跳到主要內容

接入指南

以下是快速上手使用此數位貨幣中心化交易所API 的簡要說明：

取得API 金鑰​

在申請API 金鑰之前，需要先在CoinEx 申請帳號，具體的申請流程可以參考幫助中心

準備好帳號後，可以在開發者控制台中產生API 金鑰，確保具有所需的權限。

API 呼叫準備​

根據業務需求選擇對應的API 接口，查閱對應的API 文件以了解請求方式、參數和返回結果。

具體可以查看業務分組查看，然後去對應的模組中尋找對應的API 接口，或者使用搜索功能快速查找。

建置請求​

使用您選擇的程式語言，建立符合API 要求的請求，包括設定請求方法、URL、請求頭和參數等。

資訊

HTTP 的基礎網域為：https://api.coinex.com/v2

WS 現貨和合約的基礎地址不同，分別如下：

公共參數：

資訊

在接口文檔頁中標明需要簽名的HTTP接口，需要使用以下兩個公共HTTP HEADER 參數來做請求的驗證，具體的使用方法可以參考認證

  • X-COINEX-KEY
  • X-COINEX-SIGN
資訊

如果需要限制請求的有效時間，在所有的HTTP介面都可以透過以下公共HTTP HEADER 參數來限制請求的有效時間。

伺服器收到請求時會判斷請求中的時間戳X-COINEX-TIMESTAMP，如果是5000毫秒(預設值)之前發出的，則請求會被認為無效。這個時間視窗值可以透過傳送可選參數X-COINEX-WINDOWTIME來自訂。

  • X-COINEX-TIMESTAMP。必選參數，用於指示為請求的發出時間。
  • X-COINEX-WINDOWTIME。可選參數，用於指示請求存活的視窗時間，預設為5000毫秒。
資訊

在所有的API 中，時間請求參數和回應欄位都是毫秒級的時間戳記。

處理回應​

解析API 傳回的回應數據，根據需要進行相應的處理，如錯誤處理、資料提取等。

HTTP 回應處理​

  1. HTTP回應應先判斷status_code 是否為200，然後再進行下一步的處理。
  2. 正常的HTTP回應會有統一的回應結構，需要透過判斷該結構中的code欄位來決定回應是否正常，code在正常情況下應該為0。

HTTP正常回應的統一結構如下：

{
    "code": 0,
    "data": ...
    "message": "OK"
}

WS 回應處理​

  1. WS 應該先處理訂閱請求的回應，當發送訂閱請求後，伺服器會先回傳訂閱結果回應，WS 伺服器的回應是透過zip壓縮的，需要先解壓縮。
  2. 需判斷回應結果中的code欄位是否為0。

WS正常回應的統一結構如下：

{
  "id": 4,
  "message": "OK",
  "code": 0
}
  1. 訂閱成功後，伺服器會在資料更新時進行推送，可依業務需求處理推播資料。

具體的錯誤解釋可以參考錯誤處理

安全性注意事項​

警告

確保在API 呼叫中使用HTTPS 協定進行資料傳輸，同時妥善保管您的API 金鑰，避免洩露，API 金鑰與您的帳號密碼的重要性是等同的，為了您的帳號和資產安全，請妥善保管並定期更換密鑰。一旦遺失金鑰，請務必及時到CoinEx 移除金鑰。