跳到內容

認證與 API Key

在 API 中心 建立 sk_ API 密鑰。完整密鑰僅在建立或輪換成功時顯示一次。

每個應用程式、環境和自動化任務都使用獨立的金鑰,以便單獨設定預算、停用、輪換和審計。

推薦使用:

X-API-Key: sk_your_key

也支援標準 Bearer 格式:

Authorization: Bearer sk_your_key

一次請求只發送一種形式。

Terminal window
curl https://omnidoc.top/api/v1/jobs \
-H "X-API-Key: $OMNIDOC_API_KEY"

Key 代表創建它的帳號,可調用該帳號有權使用的服务,只能存取該帳號自己的資源。Key 不能修改登入郵箱、密碼、手機號碼及個人資料,也不能創建、輪換或撤銷 API Key。

可選限制:

  • allowed_engines:僅允許指定的翻譯配置;空陣列表示不增加 Key 級限制。
  • expires_at:到期時間。
  • quota_limit:Key 的生命週期預算,單位為整數毫積分;0 表示不設定 Key 級預算,帳號積分仍照常結算。

在 API 中心 創建、修改限制、輪換或撤銷 Key。Key 被撤銷、停用、過期,或所屬帳號停用後,新的請求立即失敗。

輪換會產生新金鑰並立即停用舊金鑰;新金鑰沿用原有限制和已使用預算。已過期的金鑰無法輪換,請新建。需要平滑切換時,請先新建一個金鑰並部署,確認調用成功後再撤銷舊金鑰。

  • 僅在服務端或受控運行環境中保存 Key。
  • 使用環境變數或密鑰管理服務,不寫入原始碼、日誌、瀏覽器套件或公開倉庫。
  • 不將 Key 發送到 API 回應返回的上傳或下載位址。
  • 記錄 Key ID、請求 ID 和業務操作 ID;請勿記錄完整 Key。
  • 洩漏後立即輪換,並核對該 Key 的任務和結算操作。