Skip to main content

身份验证

VoiceCheap API 使用 API 密钥进行身份验证。所有 API 请求都必须在 x-api-key 标头中包含您的 API 密钥。

获取您的 API 密钥

1

登录 VoiceCheap

前往 app.voicecheap.ai 并登录您的账户。
2

导航至 API 页面

前往 app.voicecheap.ai/page-apiAPI 页面。
3

生成 API 密钥

点击 创建新密钥 并为您的密钥命名。您的完整 API 密钥只会显示一次 - 请立即复制并妥善保存。
重要提示:立即保存您的密钥您的完整 API 密钥在创建时仅显示一次。关闭模态框后,您将只能看到遮盖版本 (vc_abc...xyz)。如果您丢失了密钥,则必须将其删除并创建一个新的。

API 密钥限制

  • 每个账户最多可创建 5 个 API 密钥
  • 每个密钥都可以命名以便于识别(例如,“生产环境”、“开发环境”)
  • 密钥可以随时从 API 页面删除

使用您的 API 密钥

在每次请求的 x-api-key 标头中包含您的 API 密钥:

要求

需要付费订阅API 访问需要有效的付费订阅。免费账户无法使用 API。如果您在没有有效订阅的情况下尝试使用 API,您将收到 403 Forbidden 错误。

API 密钥安全

保持机密

切勿在客户端代码、公共存储库或任何可公开访问的位置暴露您的 API 密钥。

使用环境变量

将您的 API 密钥存储在环境变量或安全的密钥管理器中。

定期轮换

定期轮换您的 API 密钥,特别是如果您怀疑它们可能已泄露。

监控使用情况

跟踪您的 API 使用情况,以检测任何未经授权的访问。

错误响应

如果身份验证失败,您将收到以下错误之一:

错误响应示例