第 2 章 / 共 21 章約 2 分鐘

2. 建立與管理 API Key#

API Key 是呼叫所有介面的唯一憑證。

取得 API Key(控制台操作流程)#

  1. 登入 YiTuoToken 控制台。
  2. 在左側導覽列點選「API 金鑰」,進入金鑰管理頁。
  3. 點選「建立 API 金鑰」按鈕。
  4. 在彈出的對話框中填寫:
    • 金鑰名稱(必填,如「生產環境服務」,用於區分用途)
    • 額度上限(可選,留空表示不限制)
    • IP 白名單(可選,限制可呼叫的來源 IP / CIDR)
    • 過期時間(可選,到期後自動失效)
    • 可用模型白名單(可選,限定該 Key 能呼叫的模型範圍)
  5. 點選「建立金鑰」送出。
  6. 系統彈出「儲存你的新金鑰」——完整金鑰明文僅此一次顯示。點選「複製金鑰」儲存到安全位置,再點「我已儲存」關閉。

關閉彈出視窗後無法再次查看完整金鑰。系統僅儲存金鑰雜湊值,明文不落庫。若未及時儲存,請吊銷該金鑰並重新建立。

可設定項目#

配置說明
名稱便於區分用途(如「生產環境」「本機測試」)
配額上限該 Key 可消耗的額度上限,用盡後請求回傳 402
IP 白名單限制來源 IP,支援單一 IP 與 CIDR 段(逗號分隔)
有效期過期後 Key 自動失效
模型白名單限定該 Key 可呼叫的模型範圍

管理操作#

  • 吊銷: 金鑰外洩或不再使用時立即吊銷,吊銷後該 Key 的所有請求回傳 401。
  • 輪替: 建議定期建立新 Key 並逐步替換舊 Key,降低外洩風險。

安全提示: 切勿把 API Key 硬編碼進前端程式碼、公開儲存庫或用戶端 App,應透過環境變數或後端服務持有。