摘要
API 密钥允许您的应用程序、脚本和后端服务安全地访问 Astra 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 密钥遭到泄露，请立即撤销并创建新密钥。