跳至主要内容

可授予的限制和功能

API key 的安全处理​

API key 如果泄露,可能会被滥用。将 API key 嵌入应用程序中,可能会被恶意第三方从应用程序中提取出来。一般来说,请不要将您拥有的 API key 发送到应用程序用户的机器上。此外,为了即使在不慎泄露的情况下也能将影响范围降到最低,建议使用带有限制的 API key。

警告
  • 特别是在 Web 应用程序的情况下,请避免在 HTML 或 JavaScript 中写入 API key,因为网站用户可以查看到。
  • 如果无法避免将 API key 嵌入应用程序中,请对 API key 进行混淆和加密。混淆和加密可以使从应用程序中提取 API key 变得更加困难。
  • 2025/06/30 MyPage 更新之前创建的账户最初拥有的 API key 无法禁用。要禁用它,需要注销账户后重新创建一个新账户。
  • 2025/06/30 MyPage 更新之后在 MyPage 上发行的 API key 可以在 MyPage 上手动禁用。详情请参考API key 的禁用步骤。
  • 使用 API key 发行 API 发行的 API key 无法禁用。

可授予 API key 的限制和功能​

在发行新的 API key 时,可以授予以下限制和功能。这里将解释每个特性。关于授予方法,请参考API key 的发行方法。请注意,无法对已发行的 API key 事后授予这些限制和功能。

有效期限​

可以为 API key 授予有效期限。无论是在 MyPage 上发行还是使用 API key 发行 API 发行,都可以授予有效期限。

在指定有效期限时,可以指定截止日期,也可以用天数等指定有效期。不设置有效期限可以发行无限期的 API key。

在异步 HTTP 接口中使用带有效期限的 API key 的情况​

在异步 HTTP 接口中使用带有效期限的 API key 时,请将有效期限设置得足够长。通常,开始语音识别需要几分钟的时间。此外,在繁忙时期,极少数情况下可能会暂停然后重新开始,即使在识别过程中也可能需要认证。

请注意,在异步 HTTP 接口中,可以在创建语音识别 Job 时和确认 Job 状态或获取结果时使用不同的 API key(但必须属于同一账户)。

IP 地址限制​

可以为 API key 授予仅允许从特定 IP 地址访问的限制。无论是在 MyPage 上发行还是使用 API key 发行 API 发行,都可以授予此限制。

可以指定一个 IP 地址,也可以指定多个 IP 地址或指定 IP 地址范围。

API key 发行功能​

可以为 API key 授予在请求 API key 发行 API 时,代替 service ID(sid)和 service password(spw)用于认证的功能。这只能在 MyPage 上发行 API key 时授予。

万一用于 API key 发行 API 的认证信息泄露,service ID 和 service password 是无法更改的。如果一定要更改,需要注销账户后重新创建一个新账户。另一方面,在 MyPage 上发行的 API key 可以禁用。此外,API key 还可以设置有效期限和 IP 地址限制,因此可以更安全地使用 API key 发行 API。