跳至主要内容

在 MyPage 上发行 API Key 的方法

在 MyPage 上,除了可以发行 API key 外,还可以确认和删除之前在 MyPage 上发行的 API key。

在 MyPage 上与 API key 相关的操作可以在"MyPage TOP"向下滚动的[Connection Information]部分进行。可以通过这个[链接]((https://acp.amivoice.com/mypage/en/dashboard)直接访问 MyPage TOP。访问"MyPage"需要登录。

API Key 的发行步骤

  1. 点击[Connection Information]部分的"Issue API key"按钮。如下图所示,将显示"Issue API key"窗口。
  2. 在显示的窗口中,根据需要设置有效期限、连接源 IP 地址和 API key 发行功能。详情请查看限制和功能的授予
  3. 点击[Issue]按钮后,[API key]中将显示发行的 API key。关闭"Issue API key"窗口后仍可确认。

图. Issue API key 窗口

限制和功能的授予

有效期限

有效期限可以选择指定日期或指定发行后的期间。发行后的期间可以按小时或天数指定。选择[Unlimited]可以发行没有有效期限的 API key。

连接源 IP 地址

可以指定使用发行的 API key 的连接源 IP 地址限制。如果不填写任何内容,将成为没有 IP 地址限制的 API key。

如果想要指定 IP 地址范围,可以使用 CIDR 指定。

例:203.0.113.0/24

如果想要指定多个 IP 地址或范围,用空格分隔。

例:203.0.113.0/24 198.51.100.0/24

API Key 发行功能

如果想要授予 API key 发行功能,请在[Issue API key]项目的[Issuable]复选框中打勾。

已发行 API Key 的确认

在 MyPage 上发行的 API key 将在[Connection Information]中列表显示。点击表格[API key]列中各 API key 的[Show],可以显示该 API key。此外,在[Restriction]列中可以确认有效期限和 IP 地址限制的设置。

备注
  • 无法确认是否具有 API key 发行功能。
  • 使用 API key 发行 API 发行的 API key 不会显示在列表中。

API key 的删除步骤

在 MyPage 上发行的 API key 可以在 MyPage 上手动删除。

  1. 在[Connection Information]中,勾选要删除的 API key 的复选框,然后点击[Delete]按钮。
  2. 将显示[Delete API key]的确认画面,确认 API key 无误后,点击[Delete]按钮。
  3. 认证码将发送到账户注册的电子邮件地址。将此代码输入到 MyPage 上显示的[Authentication Code Confirmation]画面中,然后点击[Send]按钮。
  4. API key 删除完成,通知 API key 删除的邮件将发送到账户注册的电子邮件地址。
备注
  • 2025/06/30 MyPage 更新之前创建的账户最初拥有的 API key 无法删除。要删除需要退会后重新创建账户。
  • 使用 API key 发行 API 发行的 API key 无法删除。