摘要
API 金鑰可讓您的應用程式、指令碼和後端服務安全地存取 Astra API，而無需使用者每次都透過網頁介面登入。本文說明 API 金鑰是什麼、如何建立和使用 API 金鑰，以及如何管理或撤銷現有金鑰。
說明
什麼是 API 金鑰？
API 金鑰是一種以 sk_live_ 開頭的秘密憑證。它可讓您的應用程式以程式化的方式進行驗證並向 Astra API 發出請求。
當您需要系統與系統之間的連線、可在沒有使用者互動的情況下自動運行時，通常會使用 API 金鑰。
建議的使用案例
當您想達到以下目的時，API 金鑰是理想的選擇：
自動將 Astra 中的合格潛在客戶與您的 CRM 同步。
透過從 Astra 擷取對話和潛在客戶資料來建立自訂儀表板。
當 AI 代理程式擷取到新潛在客戶時，觸發業務工作流程。
將對話資料傳送至內部分析或報告系統。
何時不應使用 API 金鑰
不建議在公開應用程式中使用 API 金鑰，因為在這種情況下，每個使用者都需要授權存取其自己的帳戶。
在這些情況下，請改用 OAuth 身份驗證。
如何建立 API 金鑰
若要建立新的 API 金鑰：
登入您的 Astra 帳戶。
前往 帳戶 > API 金鑰。
按一下 建立金鑰。
輸入金鑰的描述性名稱，例如 正式版 CRM 同步。
按一下 建立。
重要：請立即儲存您的 API 金鑰
建立金鑰後，Astra 只會顯示一次完整的 API 金鑰。
請務必在關閉通知或離開頁面之前，複製並將金鑰儲存到安全的位置。
之後，Astra 只會顯示金鑰的縮短前綴以供識別。無法再次查看完整金鑰。
如何使用 API 金鑰
建立 API 金鑰後，請將其新增至您的應用程式、指令碼或整合。
發出 API 請求時，請在請求授權標頭中包含金鑰，通常是作為 Bearer token。
設定完成後，您的應用程式便能安全地存取 Astra API，而無需使用者透過瀏覽器登入。
管理現有的 API 金鑰
API 金鑰 頁面會顯示所有作用中金鑰的資訊。
欄位 | 說明 |
名稱 | 建立 API 金鑰期間指派的名稱 |
金鑰前綴 | API 金鑰的前幾個字元，用於識別金鑰 |
建立時間 | 金鑰建立的日期和時間 |
上次使用時間 | 金鑰上次使用的時間；如果金鑰從未使用過，則會保持空白 |
如何撤銷 API 金鑰
如果出現以下情況，您可能需要撤銷 API 金鑰：
金鑰被意外洩露或分享
不再需要某項整合
擁有此金鑰存取權限的團隊成員已離職
作為安全流程的一部分，您正在輪換憑證
若要撤銷 API 金鑰：
在 API 金鑰 清單中找到該金鑰。
按一下 刪除 選項。
確認操作。
撤銷後會發生什麼事？
API 金鑰將立即失效。
任何使用該金鑰的應用程式、指令碼或整合，在設定新的有效金鑰之前，都將無法再存取 Astra API。
使用 API 金鑰的安全最佳實務
請遵循以下建議，確保您的 API 金鑰安全無虞：
切勿將 API 金鑰包含在前端或客戶端程式碼中。
將 API 金鑰儲存在安全的密碼管理器或環境變數中。
為測試和正式環境使用不同的 API 金鑰。
定期輪換 API 金鑰。
撤銷未使用或過期的金鑰。
如果 API 金鑰遭到洩露，請立即撤銷並建立新的金鑰。