概述

認證

所有 TokSpan API 請求均使用 Bearer tokens（API 金鑰）進行認證。本頁涵蓋金鑰建立、使用方式及安全最佳實踐。

Bearer Token 驗證

在每個請求的 Authorization 標頭中附上您的 API 金鑰：

http
Authorization: Bearer sk-your-api-key-here

建立 API 金鑰

  1. 登入 TokSpan 儀表板
  2. 前往側邊欄中的API 金鑰
  3. 點擊+ 新增金鑰
  4. 為您的金鑰取一個描述性名稱（例如「production-backend」、「dev-testing」）
  5. 可選擇設定每月消費上限與允許的模型
  6. 立即複製金鑰 — 它不會再次顯示
您的 API 金鑰僅顯示一次。請安全儲存 — 我們無法復原。若遺失，請產生新金鑰並撤銷舊金鑰。

金鑰範圍限制與權限

每個 API 金鑰可設定特定權限範圍：

  • 模型：限制金鑰可存取的模型
  • 每月預算：設定硬性消費上限，達上限時自動停用金鑰
  • IP 白名單：僅允許來自特定 IP 範圍的請求
  • 速率限制：每個金鑰的自訂 RPM/TPM 限制

使用環境變數

在生產環境中始終使用環境變數 — 絕不將金鑰寫死在程式碼中：

python
import os
from openai import OpenAI

client = OpenAI(
    api_key=os.environ["TOKSPAN_API_KEY"],
    base_url="https://api.tokspan.com/v1",
)

撤銷與輪換金鑰

您可以從儀表板即時撤銷任何 API 金鑰。我們建議每 90 天輪換金鑰，並立即撤銷任何您懷疑已遭入侵的金鑰。