API 密鑰

最近一次更新: 2026年8月20日

API 金鑰為自動化系統、交易機器人、操作腳本、報告管道及 FIX 交易會話提供程式化存取,以操作貴機構帳戶。本文介紹 API 金鑰權限模型、金鑰與帳戶的對應方式、機構治理如何適用於金鑰發起的操作,以及金鑰管理本身的治理機制。

API 金鑰並非擁有登入憑證的成員。API 金鑰採用獨立且較為簡單的權限模型:

成員

API 密鑰

身分驗證

個人登入(需 2FA)

API 金鑰登入憑證

介面存取

否,僅限 API

權限模型

工作流程配置 + 帳戶角色

API 金鑰權限適用於所選帳戶

按帳戶的差異化設定

是,角色可在不同帳戶上授予不同權限

否,金鑰權限統一適用於所有已選帳戶

可發起提款及轉帳請求

是,在權限允許的情況下

是,在權限允許的情況下

可審批請求

是,惟自身請求除外

從未投資

管理工作流程

是,依據其工作流程配置文件

從未投資

兩種模型刻意分開設計。成員擁有角色、配置文件及按帳戶細分的權限,因為人員往往承擔多樣化的職責。金鑰採用扁平的權限加帳戶模型,確保自動化程序精簡、統一,且便於審計。

API 金鑰包含兩項設定:可執行的操作(權限)及適用範圍(帳戶)。

權限

分組

權限

允許操作

資金

查詢資金

查看餘額及資金狀態

存款

產生充值地址並查看充值歷史紀錄

提款

發起提款請求(請參閱「治理與 API 金鑰」)

理財

配置及取消配置 Earn 產品

訂單

查詢未成交訂單

查看未成交訂單及進行中的交易

查詢已完成訂單

查看歷史訂單及已完成交易

建立和修改訂單

下單及修改訂單

取消未成交訂單及平倉

取消未成交訂單並平倉

地址

新增提款地址

發起新增白名單地址的請求

更新提款地址

發起修改白名單地址的請求

數據

查詢分類帳

查看交易及帳本紀錄

匯出數據

匯出帳戶資料以供報告及對帳之用

帳戶對應

每個金鑰在建立時會對應至一個或多個帳戶,並可於日後編輯。金鑰的權限會統一套用至所有已選取的帳戶:

  • 例如,擁有「查詢資金」及「建立並修改訂單」權限、對應兩個帳戶的金鑰,可讀取兩個帳戶的餘額並下單交易,除此之外不具任何其他操作權限。
  • 金鑰不支援按帳戶設定不同權限。如自動化程式需要在某一帳戶交易、同時僅讀取另一帳戶,請使用兩個獨立金鑰。這樣可讓每個金鑰的影響範圍一目了然。

需要時指定特定帳戶

若省略 account_id,私有 API 請求將使用 Organization 的主帳戶:

bash

Bash

POST /0/private/AddOrder

如需操作指定帳戶,請在 URL 中以查詢參數形式傳入 account_id

bash

Bash

POST /0/private/AddOrder?account_id=W5PB62NTPNYT6TYH

請在 URL 傳入此參數,而非置於請求正文中。明確指定的 account_id 優先於主帳戶的備用預設值。此設定不會擴展金鑰的帳戶對應範圍或權限。若金鑰無權操作所選帳戶,該請求將被拒絕。

FIX 連線

具備訂單權限的金鑰,除支援 REST 及 WebSocket API 外,亦支援透過 FIX 連線進行現貨交易。FIX 會話沿用對應金鑰的相同權限與帳戶對應設定:僅可在金鑰已選取的帳戶範圍內、按金鑰權限進行交易。執行 FIX 訂單流程的機構,通常為每個會話專設一個金鑰,範圍限定至該交易台所操作的帳戶。

註:

WebSocket 交易功能目前僅限 Owner 使用,API 金鑰暫時未能在主帳戶以外的帳戶使用此功能。其他帳戶的自動化訂單流程建議使用 REST 或 FIX。請參閱 適用範圍與限制

安全設定

設定

描述

密鑰到期時間

可選到期日,到期後金鑰將自動停止運作

查詢起訖日期

將資料查詢限定在指定日期範圍內

WebSocket 連線

啟用或停用即時串流

自訂隨機數字窗口

針對高頻使用的重放保護調校

IP 限制

將金鑰使用限制於指定 IP 位址或 CIDR 範圍

貼士:

請為每個金鑰設定最低所需權限、最少帳戶及最嚴格的 IP 限制,確保其僅執行必要操作。請按系統分別建立金鑰,例如交易機器人與報告系統各用一個,以便在需要撤銷時精準處理。

組織治理同時適用於金鑰的操作行為及管理方式。

金鑰的操作行為

適用於成員的兩類規則,同樣適用於金鑰:

  • 直接操作即時執行。交易、理財、餘額查詢、分類帳查詢及資料匯出均即時完成,範圍限於金鑰的權限及已選帳戶。
  • 受治理操作會建立請求。由金鑰發起的提款或地址變更,與由成員發起的操作進入同一流程:工作流程政策決定其是即時完成,還是進入審批佇列等待人工審核。

金鑰只能發起受治理的請求。金鑰不具備審批權限。職責分離要求每次審批均須由真人成員執行,自動化腳本無法替代人工判斷。當提款請求政策要求兩次審批時,由金鑰發起的提款同樣需要等待兩位成員審批,與成員發起的提款完全一致。

API 呼叫成功並不代表提款已完成

請在設計自動化流程時考慮此非同步特性。WithdrawFunds 會同時回傳 approval_request_idrefid

bash

Bash

{
  "error": [],
  "result": {
    "refid": "FTcLNGa-4ZWmo4GCo8wrBNZz5v53v9",
    "approval_request_id": "656a021a-1d55-42c9-853a-aea57bf5abd1"
  }
}
  • refid 僅確認請求已建立,並不代表資金已轉出。提款金額在提交時會於來源帳戶鎖定,待請求獲批准後方可結算。請參閱 提交後資金即被鎖定
  • approval_request_id 是追蹤該提款審批的識別碼。請將其與您自己的提款記錄一併保存。
  • 待審批的提款請求不會顯示於 WithdrawStatus。遭拒絕或已到期的請求不會產生任何提款記錄,因此在 WithdrawStatus 中查無結果,並不代表提款從未提交。

若自動化系統將 refid 視為提款完成的憑證,仍在審批佇列中等待的提款將被誤報為已結算;若對帳系統以「不在 WithdrawStatus 中即視為從未提交」作推斷,則對待審批及已拒絕的請求均會得出錯誤結論。

API 金鑰亦無法進入管理工作流程。團隊存取管理、API 金鑰、帳戶、地址(發起地址請求除外)及政策的管理,均屬 Member 專屬操作。

金鑰的管理方式

建立、編輯及撤銷 API 金鑰屬於受治理的操作,須透過專屬的 Manage API Keys 工作流程執行,與 Manage Team & Access 分開處理。此分離設計有兩層重要意義:

  • 管理員各司其職。您可授權運營工程師管理金鑰,而無需賦予其更改 Member 存取權限的能力,反之亦然。
  • 政策各自獨立。金鑰管理可設有專屬的審批要求。許多 Organization 要求對建立或修改金鑰進行獨立審批——新憑證即意味著進入帳戶的新途徑——同時保持撤銷操作快速高效。
  1. 請前往 API 金鑰,然後選擇 建立金鑰
  2. 請以金鑰用途命名,說明其服務的系統及所執行的功能,以便在審核及安全事件中一目了然。
  3. 請選擇金鑰的權限。
  4. 請選擇金鑰所操作的帳戶。所有選定帳戶均適用相同權限。
  5. 請設定安全選項:到期日、IP 限制、隨機數視窗。
  6. 請審閱並確認。如果「管理 API 金鑰」政策要求審批,請求將等待所需審批完成後方可發出金鑰。
注意:

編輯金鑰的權限或帳戶,以及撤銷金鑰,均須遵循相同的治理流程。

疑難排解

此次 API 呼叫已建立提款請求,目前正由「提款請求」政策暫停,等待審批。請前往「請求」頁面查看,該請求將以金鑰作為發起方顯示於列表,等待所需的成員審批。這正是治理模型的預期運作方式:由自動化系統提出,由人工審批。

請求等待期間,相關金額已在來源帳戶鎖定,作為提款預留資金。請使用此次 API 呼叫返回的 approval_request_id 追蹤請求狀態。

發生錯誤的帳戶並未納入金鑰的帳戶對應範圍。金鑰僅對其所選帳戶生效。請編輯金鑰以新增該帳戶,並注意金鑰的完整權限將同樣適用於該帳戶,因為金鑰不支援按帳戶分別設定權限。如果範圍過廣,建議為新帳戶另行建立一個專屬金鑰。

單一金鑰無法對不同帳戶設定不同權限。請建立兩個金鑰:一個交易金鑰對應帳戶 A,一個唯讀金鑰對應帳戶 B。權限範圍較窄的金鑰亦更便於審核,撤銷時也更安全。

管理 API 金鑰工作流程可能需要審批,相關請求仍在待處理。只有在收集到所需審批後,金鑰及其私密資訊才會發放。請在「請求」頁面查看該請求的狀態。

不可以。審批始終需要由真人成員執行。這是系統規則,並非可配置的政策。正是這一規則,確保了在自動化流程發起資金操作時,多方審批機制具有實際意義。