摘要
API Keys 允许您的应用程序、脚本和后端服务安全地访问 Astra API，而无需每次都通过 Web 界面进行用户登录。本文介绍了 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 请求时，请将该密钥包含在请求的授权标头中，通常作为 Bearer token 使用。
配置完成后，您的应用程序即可安全地访问 Astra API，而无需用户通过浏览器登录。
管理现有的 API Keys
API Keys 页面显示有关所有活动密钥的信息。
列 | 描述 |
名称 | 创建 API Key 时为其指定的名称 |
密钥前缀 | API Key 的开头部分，用于识别密钥 |
创建日期 | 密钥创建的日期和时间 |
最后使用时间 | 密钥最近一次的使用时间；如果从未被使用过，则保持为空白 |
如何撤销 API Key
在以下情况下，您可能需要撤销 API Key：
密钥被意外泄露或共享
不再需要某个集成
拥有密钥访问权限的团队成员已离职
作为安全流程的一部分，您正在轮换凭证
要撤销 API Key：
在 API Keys 列表中找到该密钥。
点击 Delete 选项。
确认该操作。
撤销后会发生什么？
API Key 将立即失效。
任何使用该密钥的应用程序、脚本或集成将无法再访问 Astra API，直到配置了新的有效密钥。
使用 API Keys 的安全最佳实践
请遵循以下建议以确保您的 API Keys 安全：
切勿在前端或客户端代码中包含 API Keys。
将 API Keys 存储在安全的密钥管理器或环境变量中。
为测试环境和生产环境使用单独的 API Keys。
定期轮换 API Keys。
撤销未使用或过期的密钥。
如果 API Key 遭到泄露，请立即将其撤销并创建一个新的。