Felo API PlatformFelo API Platform

開始

認證

使用 API keys 認證請求，遵循安全實務，並處理認證錯誤。

Felo API Platform 的所有 API 請求都需要使用 API Key 認證。本指南說明如何認證請求，以及如何處理常見認證問題。

API Key 認證

Felo 的 v2 endpoints 使用 API Key 認證。你的 API Key 用於識別應用，並授予訪問平臺能力的許可權。

工作方式

  1. 從 Felo API Platform API Keys 頁面 取得 API Key
  2. 在每個 API request 的 Authorization header 中加入 API Key
  3. 平臺驗證 API Key 並處理請求

Header 格式

使用 Bearer 認證方案，把 API Key 放入 Authorization header：

Authorization: Bearer YOUR_API_KEY

示例請求

curl -X POST https://openapi.felo.ai/v2/chat   -H "Authorization: Bearer sk_live_abc123xyz789"   -H "Content-Type: application/json"   -d '{"query": "What is machine learning?"}'

取得 API Key

  1. 開啟 Felo API Platform API Keys 頁面
  2. 如果系統提示，請登入 Felo 賬戶
  3. 輸入 key 名稱並點選 建立 Key
  4. key 出現後複製完整內容。完整 key 只顯示一次
  5. 安全儲存 key，並把它作為 FELO_API_KEY 使用

安全最佳實踐

1. 安全儲存 API Keys

不要把 API Key 硬編碼在原始碼裡：

# Bad - API Key exposed in code
api_key = "sk_live_abc123xyz789"

請使用環境變數或安全設定：

# Good - API Key from environment
import os
api_key = os.environ.get('FELO_API_KEY')

2. 使用環境變數

Linux/macOS:

export FELO_API_KEY="sk_live_abc123xyz789"

Windows PowerShell:

$env:FELO_API_KEY="sk_live_abc123xyz789"

3. 定期輪換 Keys

定期生成新 API Keys，並撤銷舊 key，以降低安全風險。

4. 為不同環境使用不同 Keys

為 development、staging 和 production 建立不同 API Keys。

5. 不要在使用者端暴露 Keys

API Keys 只應在 server-side code 中使用。不要放入 frontend JavaScript、mobile app source code、public repositories 或 client-side config。

認證錯誤

Error Code說明解決方式
INVALID_API_KEYAPI Key 無效、格式錯誤或已撤銷檢查 API Key 是否正確且未被撤銷
MISSING_AUTHORIZATION缺少 Authorization header在請求中加入 Authorization header
MALFORMED_AUTHORIZATIONAuthorization header 格式錯誤使用 Authorization: Bearer YOUR_API_KEY
EXPIRED_API_KEYAPI Key 已過期在 API Keys 頁面 生成新 API Key
RATE_LIMITED短時間內請求過多降低請求頻率或聯絡 support 提升限制

疑難排解

INVALID_API_KEY

可能原因：key 複製錯誤、key 已撤銷，或使用了錯誤環境的 key。

解決方式：

  1. 檢查 API Key 是否有拼寫錯誤
  2. 在 API Keys 頁面 確認 key 未被撤銷
  3. 確認目前環境使用了正確 key
  4. 必要時生成新 API Key

MISSING_AUTHORIZATION

確認請求包含 Authorization header，且 header 名稱拼寫正確。

MALFORMED_AUTHORIZATION

使用精確格式：Authorization: Bearer YOUR_API_KEY。Bearer 後只保留一個空格，不要給 API Key 加引號。

Rate Limiting

Rate limits 按 endpoint 執行，而不是按 API Key 全域性執行。是否有限制請檢視每個 endpoint 的文件。

當超過限制時，API 會返回 429 Too Many Requests，並帶有 X-RateLimit-* headers 和 Retry-After。請始終從 response headers 讀取目前有效限制。

需要幫助？

  1. 仔細檢查本指南
  2. 檢視 Getting Started
  3. 在 API Keys 頁面 驗證 API Key
  4. 帶上 request ID 聯絡 [email protected]

下一步