开发者文档
安全与数据
安全地管理 API 密钥和权限范围,并了解每个集成可以访问哪些笔记。
API 密钥管理
- 完整的 API 密钥(
alt_live_...)只在创建时显示一次。Alt 不保存密钥原文,因此之后无法再次查看。若密钥丢失,请重新签发。 - 完整的 Webhook 签名密钥(
whsec_...)也只在创建时显示一次。Alt 使用 AES-256-GCM 加密存储,仅在为外发请求签名时使用,因此无法在控制台再次查看。如需新密钥,请重新创建端点。 - 请把密钥存入密钥管理服务。切勿嵌入前端代码、移动应用或代码仓库。
- 如需轮换密钥,请在控制台为同一个集成签发新密钥。把系统切换到新密钥后再吊销旧密钥。吊销会立即生效。
- 创建密钥时可选择设置有效期,过期密钥会被自动拒绝。
- 每个系统使用独立的密钥。分开预发布环境和生产环境后,吊销其中一个密钥不会中断另一个环境。
- 没有沙箱或测试模式。每个 API 密钥都可以读取真实笔记。请为预发布环境和生产环境创建独立的集成。若要在不等待真实录音的情况下测试接收端,可使用创建端点时发送的 verification 事件,或在控制台点击“发送测试”。
每个集成可访问的数据
- 个人集成只能访问所有者的个人笔记。团队空间集成只能访问共享到该团队空间的笔记,无法访问成员的个人笔记。
- 团队空间集成只能由团队空间所有者创建。
- 请求 API 密钥可见范围外的笔记时会返回
404。响应不会透露该笔记是否存在。 - 当某条笔记离开你的范围时,你会收到
note.deleted (reason: access_lost),该笔记也会从列表中消失。请删除你保存的副本或阻断其访问。
权限范围(scope)
| 权限范围 | 授予的权限 |
|---|---|
| notes:read | 列出笔记并读取笔记元数据。 |
| transcripts:read | 读取转录文本和说话人分段。 |
| summaries:read | 读取摘要(Markdown)。 |
| webhooks:manage | 通过公开 API 创建、更新、删除和测试 Webhook 端点。 |
只授予集成实际需要的权限范围。需要 API 密钥未获授权限的请求会以 403 insufficient_scope 失败。
API 请求限制
- 每个 API 密钥每分钟最多可发起 120 次请求。超出限制后会返回
429 rate_limited和Retry-After响应头。请至少等待响应头指定的时间后再重试。 - 不要高频重复查询完整笔记列表,请使用 Webhook 和
updated_after进行增量同步。 - 保存笔记、转录和摘要响应中的
ETag,并在下一次请求的If-None-Match中发送。内容未变更时会返回不含正文的304,从而减少不必要的数据传输。
隐私
- 转录和摘要属于用户内容,可能包含个人信息。只获取集成真正需要的部分,并妥善保护你所存储的数据。
- 务必同步删除。收到
note.deleted后,无论原因如何,都要删除已保存的副本或阻止访问。还应定期检查完整笔记列表,以防遗漏事件。 - Webhook URL 必须是公网 HTTPS 端点。私有地址、回环地址和云元数据地址会被拒绝,且不会跟随重定向。
- 调用 API 需要集成所属工作区拥有有效订阅;没有订阅时,请求会以
403 plan_required失败。 - 关于 Alt 自身如何处理用户数据,请参见我们的隐私政策。