服务器 API Key 管理¶
在这篇文章中
信息
API key 是 授权 API 请求访问 Invapi 的一种便捷方式，使您能够独立于控制中心和个人账户来访问特定服务器的 Control Panel。
若要访问整个账户或特定服务器，请在 Invapi 控制面板的个人区域生成 API 访问密钥。请按照以下说明进行操作。
获取特定服务器的 API key¶
-
前往 Invapi;
-
请选择您想要访问其外部服务器控制面板的服务器：My Servers >> You require a server;
-
生成 API key：
- 导航至 Configuration 选项卡并选择 API keys & control panel 部分。
- 点击
Add new按钮；
- 在 Name 字段中，输入用于标识该密钥的名称；
- 在 IP ACL 字段中，仅指定允许使用此密钥访问的 IP 地址，或者将其留空以实现无限制访问；
- 勾选 Active 复选框以激活该密钥；
- 点击
Add new API key按钮。
系统将向您显示 API key。
警告
请务必复制并保存 API key 的值，因为它只会显示一次。Invapi 仅存储密钥的哈希值，因此如果原始密钥丢失，则需要重新创建。
编辑或删除 API key¶
要编辑或删除 API key，请导航至生成该密钥的账户或特定服务器，然后点击所需的密钥。在弹出的窗口中，进入 General Info 选项卡，您可以在此处：
- 在 Name 字段中更改密钥名称；
- 在 IP ACL 字段中设置允许使用该密钥进行调用的 IP 地址；
- 更改或设置使用此 API key 登录时的通知方式。这仅适用于为整个账户颁发的密钥，并涉及通知地址（电子邮件/URL）字段；
- 使用 Active 复选框启用或暂时禁用此功能。
接下来，点击 Save API key 按钮以保存您的更改。
要删除 API key，请点击 Delete API key 按钮。
警告
API key 一旦被删除，将无法恢复。
使用 API key¶
API key 可以通过以下方式使用：
-
为了获得后续向 Invapi 中的账户或服务器发起 API 请求所需的会话令牌 (session token)，必须进行授权。根据所使用的 API key，可以通过 auth/login 调用，通过为整个账户或特定服务器提供的 API key 来获取授权。如果授权成功且在数据库中找到了该密钥，系统将返回会话令牌
$HOSTKEY_TOKEN。 -
为了访问 Server Control Panel（这允许您在无需登录 Invapi 控制中心账户的情况下访问服务器），并将控制面板作为独立模块嵌入到您的计费系统中以管理 HOSTKEY 服务器，您必须生成特定于服务器的 API key。
API key 使用信息¶
在 Usage history 选项卡中，为账户或服务器选择一个特定的密钥并点击它，即可查看该 API key 在特定期间内的所有登录记录。输出结果将包括用于登录的电子邮件和 IP 地址、登录成功状态以及事件发生的日期和时间。
无需 Web 面板获取 API key¶
您可以通过利用 API 管理密钥的方法，在不使用 Web 控制面板的情况下获取 API key。这些方法可以从命令行执行，或嵌入到 Web 解决方案中。