API 存取設定
如果你想透過程式存取工作空間，可以建立 API 金鑰。本篇將說明如何取得和管理 API 金鑰。
取得 API 金鑰
步驟 1：進入 API 金鑰管理
- 進入你的工作空間
- 點擊「API 金鑰」分頁（API Keys）
步驟 2：建立新金鑰
點擊「發行新金鑰」按鈕（Issue New）。
重要
- 在「發行新 API 金鑰」對話框中會顯示：「建立新的 API 金鑰以存取工作區資源。完整金鑰僅會顯示一次。」
- 請務必在建立後立即複製並安全保存金鑰。
步驟 3：設定金鑰
在對話框中填寫：
- 金鑰名稱（必填）：給金鑰一個容易辨識的名稱（例如：「生產環境」、「測試用」）
- 如果未填寫，會顯示「請輸入金鑰名稱」錯誤訊息
- 到期日期（選填）：點擊「選擇到期日期」按鈕設定金鑰的有效期限
- 留空表示永不過期
- 點擊日期選擇器按鈕（帶有日曆圖示）可以選擇日期
步驟 4：發行並保存金鑰
點擊「發行金鑰」按鈕後，系統會顯示完整的 API 金鑰。
重要
- 金鑰只會在建立時顯示一次。請立即複製並安全保存。
- 如果遺失，你需要建立新的金鑰。
點擊「複製」按鈕複製完整金鑰，然後點擊「完成」。
管理 API 金鑰
查看已建立的金鑰
在「API 金鑰」分頁（API Keys）中，你可以看到所有已建立的金鑰：
- 名稱：金鑰的識別名稱
- 金鑰前綴：金鑰的前幾個字元（用於識別）
- 建立時間：金鑰建立的日期
- 到期時間：金鑰失效的日期（如有設定）
撤銷金鑰
如果金鑰外洩或不再需要：
- 找到要撤銷的金鑰
- 點擊「撤銷」按鈕（Revoke）
- 確認撤銷
注意
撤銷後，使用該金鑰的所有請求都會失敗。請確保已更新所有使用該金鑰的應用程式。
安全最佳實踐
保護你的金鑰
- 不要在前端代碼中使用 API 金鑰
- 不要將金鑰提交到版本控制系統（如 Git）
- 使用環境變數存放金鑰
- 為不同環境（開發、測試、生產）使用不同金鑰
- 定期檢查並撤銷不再使用的金鑰
使用環境變數
# .env 檔案（不要提交到 Git）
CODEER_API_KEY=your-api-key-here
# Python 範例
import os
api_key = os.environ.get('CODEER_API_KEY')
設定到期時間
建議為金鑰設定合理的到期時間：
- 臨時測試：設定幾天或幾週
- 正式使用：根據安全政策設定，例如每季輪換
使用 API
取得 API 金鑰後，請參閱 API 文件：
- API 參考文件概覽 - 基礎 URL、認證和回應格式
- Chat API - 使用你的 Agent 建立聊天整合
- SSE 串流 - 即時串流回應
官方 API 範例
如需完整的工作範例，請參考官方範例專案： https://github.com/codeer-ai/codeer-api-examples
範例包含：
- Chat API 的完整示範
- Server-Sent Events (SSE) 的即時串流回應
- Python / PHP / JavaScript 的多語言範例
- GET_APIKEY.md：取得 API 金鑰的補充說明
常見問題
API 金鑰可以做什麼？
API 金鑰用於程式化存取你的工作空間資源，包括與 Agent 對話、管理設定等。
金鑰遺失怎麼辦？
金鑰無法找回。請撤銷遺失的金鑰，然後建立一個新的。
可以建立多個金鑰嗎？
可以。建議為不同用途或環境建立不同的金鑰，方便追蹤和管理。
金鑰到期後會怎樣？
到期後，使用該金鑰的請求會被拒絕。你需要建立新的金鑰並更新應用程式。