跳至主要内容

API 金鑰

每個請求都帶金鑰:

Authorization: Bearer vmk_...

金鑰形狀是 vmk_<id>_<secret>。secret 只在簽發或輪替時顯示一次;紀錄只保存 <id>,可在工單中分享。

安全保存​

  • 放在環境變數(VEINMESH_API_KEY)或密碼管理器。不要放程式、notebook、Git、 截圖或聊天。
  • 每個人一把,每個 agent 或自動化流程各一把,外洩時才能單獨撤銷。
  • 撤銷後約一分鐘內失效。已開啟的 WebSocket 會收到錯誤並關閉。
  • 效期與輪替重疊見限制。

金鑰能讀什麼​

金鑰的 scope 與 principal 的 grant 共同決定可讀範圍。/v2 目前強制:

功能需要
目錄、日曆、schema任何有效金鑰
盤口快照(/v2/data)book_snapshot kind、history、盤口檔數
K 線(/v2/bars)history,以及 bar 或 book_snapshot kind
匯出(/v2/exports)上述快照權限加 export
即時(/v2/stream)book_snapshot kind、live、盤口檔數

金鑰也帶交易所與商品 scope,但 /v2 目前尚未套用。已套用的是資料種類、歷史、 即時、匯出與盤口檔數。

被拒(403 forbidden)會指出缺少哪一項。請管理員做最小幅度的調整。

檢查金鑰​

curl -s -H "Authorization: Bearer $VEINMESH_API_KEY" \
https://data.cyberun.cloud/v2/whoami

回應含金鑰紀錄(不含 secret)、principal 與宣告的 scope。enforcement 說明 哪些部分真的套用:data_kinds、history、live、export、book_depth 為 true;venue、instrument 為 false,因為它們記在金鑰上但尚未套用到 /v2 請求。effective 是 declared 的過渡 alias,保留一個版本。v1 資料 API 雖已退役,/v2/whoami 仍是目前的身分端點。

輪替與撤銷​

輪替與撤銷是管理操作;請管理員處理。輪替會簽發同 scope、同效期的新金鑰,舊 金鑰在重疊期後失效。沒有重疊時,舊金鑰立即失效。

金鑰外洩時,撤銷比輪替安全:輪替在重疊結束前仍讓舊 secret 有效。管理員可用 管理的端點做這兩件事。