摘要
API Keys 讓您的應用程式、腳本和後端服務能夠安全地存取 Astra API，而無需每次都透過網頁介面登入。本文將說明 API Keys 的定義、建立與使用方式，以及如何管理或撤銷現有的金鑰。
說明
什麼是 API Key？
API Key 是一種以 sk_live_ 開頭的秘密憑證。它允許您的應用程式進行身份驗證，並以程式化方式向 Astra API 發送請求。
當您需要執行自動化、無需使用者互動的系統對系統連線時，通常會使用 API Keys。
建議使用情境
在以下情況下，API Keys 是理想的選擇：
將合格潛在客戶從 Astra 自動同步到您的 CRM。
透過從 Astra 提取對話和潛在客戶資料來建立自訂儀表板。
當 AI 代理捕捉到新的潛在客戶時觸發業務工作流程。
將對話資料發送到內部分析或報告系統。
何時不應使用 API Keys
若應用程式是面向大眾的，且每個使用者都需要授予其個人帳戶的存取權限，則不建議使用 API Keys。
在這些情況下，請改用 OAuth 進行身份驗證。
如何建立 API Key
若要建立新的 API Key：
登入您的 Astra 帳戶。
前往 Settings > API Keys。
點擊 Create API Key。
輸入描述性的金鑰名稱，例如 Production CRM Sync。
點擊 Create。
重要：請立即儲存您的 API Key
金鑰建立後，Astra 僅會顯示一次完整的 API Key。
請務必在關閉通知或離開頁面之前，將金鑰複製並儲存到安全的位置。
之後，Astra 僅會顯示金鑰的簡短前綴以供識別。完整的金鑰無法再次檢視。
如何使用 API Key
建立 API Key 後，請將其新增至您的應用程式、腳本或整合服務中。
發送 API 請求時，請將金鑰包含在請求的授權標頭（Authorization header）中，通常作為 Bearer token 使用。
設定完成後，您的應用程式即可安全地存取 Astra API，無需使用者透過瀏覽器登入。
管理現有的 API Keys
API Keys 頁面會顯示所有現用金鑰的資訊。
欄位 | 說明 |
名稱 (Name) | 建立 API Key 時指定的名稱 |
金鑰前綴 (Key prefix) | API Key 的前幾個字元，用於識別金鑰 |
建立時間 (Created) | 金鑰建立的日期與時間 |
上次使用 (Last used) | 金鑰最近一次的使用時間；若從未被使用則保持空白 |
如何撤銷 API Key
若發生以下情況，您可能需要撤銷 API Key：
金鑰遭到洩露或意外分享
整合服務不再需要使用
擁有金鑰存取權限的團隊成員已離職
作為安全程序的一部分進行憑證輪替
若要撤銷 API Key：
在 API Keys 列表中找到該金鑰。
點擊 Delete 選項。
確認該操作。
撤銷後會發生什麼？
API Key 將立即失效。
任何使用該金鑰的應用程式、腳本或整合服務，在設定新的有效金鑰之前，將無法存取 Astra API。
使用 API Keys 的安全最佳實踐
請遵循以下建議以確保您的 API Keys 安全：
切勿將 API Keys 包含在前端或客戶端程式碼中。
將 API Keys 儲存在安全的密鑰管理器（secret manager）或環境變數中。
為測試環境與生產環境使用不同的 API Keys。
定期輪替 API Keys。
撤銷未被使用或過期的金鑰。
若 API Key 遭到洩露，請立即撤銷並建立一個新的。