API 受众与兼容性
哪些 VoiceStudio 接口公开、仅供浏览器使用,哪些绝不面向客户。
控制平面的每个操作都属于一个受众。共享 OpenAPI 来源不会使操作公开。
| 受众 | 路由 | 调用方 | 此处发布? |
|---|---|---|---|
| 公共开发者 API | /v1/* | 有范围限制的开发者凭证 | 是,包含在 Cloud 投影中 |
| 网站边缘 API | 经审核的匿名 /v1/marketing/* | 网站自身的表单 | 否 |
| 仪表板/BFF API | /dashboard/v1/* | 使用同源会话的仪表板 | 否 |
| 操作员 API | 经审核的 /internal/v1/* | 平台操作员 | 否 |
| 内部服务 API | 其他 /internal/v1/* | 私有服务 | 否 |
网站边缘、操作员和内部路由绝不属于客户 API。它们及仅供其使用的架构均不包含在 /cloud-openapi.json 中。浏览器绝不会收到开发者凭证,公共客户端也绝不会使用仪表板会话 Cookie。
兼容性
尚未发布跨产品兼容性子集。本地 0.5.0 和 Cloud 预览版 1.0.0 契约均包含 POST /v1/audio/transcriptions,但字段、身份验证、Artifact 和 Job 行为、超时及错误并未声明可以互换。需要 #71 中的行为测试针对指定版本组合通过。在此之前,相同的路由名称仅表示重叠,不代表兼容。
发布 Cloud
在 OpenAPI 文档或可执行示例中发布活跃的 Cloud 服务器是发布步骤。需依次满足:
- 已验证的生产环境 DNS 和 TLS。
- 身份验证、公共路由和对客户安全的失败处理的冒烟测试。
- 针对确切版本的 #71 兼容性和回滚检查。
- 重新生成不再显示
unavailable的投影。
回滚会移除活跃服务器。持久 Job、Artifact 和幂等记录保持原样。