Skip to content

Invapi 账户访问 API 密钥管理

在这篇文章中

信息

API 密钥是 无缝访问 Invapi API 请求 的一种便捷身份验证方式。

API 密钥是一种便捷的方式,用于 授权对 Invapi 的 API 请求 并独立于您的控制中心和个人账户访问特定服务器的 Control Panel

为整个 Invapi 账户获取 API 密钥

  1. 导航至 Invapi 并点击 Username >> API keys

  2. 点击 Add new 按钮以创建 API 密钥。

    • Name 字段中输入名称以标识该密钥;
    • Restrict a new API key only for the server 下拉列表中,选择该密钥是应用于整个账户 (Any) 还是特定服务器;
    • IP ACL 字段中指定允许使用此密钥访问的 IP 地址,或留空以允许无限制访问。
    • Set login notification method 下拉列表中选择一个通知方法,用于通过此 API 密钥访问账户。选项包括:
      • None(无通知);
      • E-mail
      • Webhook - 通过 HTTP 调用将登录信息发送到您的网站。
    • 如果选择 E-mail 或 Webhook,请在 Notification address (email/URL) 字段中输入相应的电子邮件或 URL。
    • 要激活密钥,请选中 Active 复选框;
    • 要添加新的 API 密钥,请点击标有 Create 的按钮。

    系统将向您显示 API 密钥。

警告

请务必复制并保存 API 密钥值,因为它仅显示一次。Invapi 仅存储密钥的哈希值,因此如果原始密钥丢失,则需要重新创建。

管理整个 Invapi 账户的 API 密钥

要编辑或删除 API 密钥,请导航至生成该密钥的账户,并点击所需的密钥。在出现的窗口中,转到 General Info 选项卡,您可以:

  • Name 字段中更改密钥名称;
  • IP ACL 字段中设置禁止使用密钥进行调用的 IP 地址;
  • 更改或设置使用此 API 密钥登录的通知方法。这仅适用于为整个账户颁发的密钥,并涉及通知地址(电子邮件/URL)字段;
  • 使用 Active 复选框启用或暂时禁用此功能。

接下来,点击 Save API key 按钮以保存更改。

要删除 API 密钥,请点击 Delete API key 按钮。

警告

API 密钥一旦删除便无法恢复。

使用整个 Invapi 账户的 API 密钥

API 密钥可用于获取会话令牌,该令牌是后续对 Invapi 中账户进行 API 请求所必需的,因此需要进行授权。可以通过 auth/login 调用获取授权,具体取决于使用的 API 密钥是用于访问整个账户还是特定服务器。如果授权成功且在数据库中找到密钥,系统将返回会话令牌 $HOSTKEY_TOKEN

整个 Invapi 账户的 API 密钥使用信息

Usage history 选项卡中,选择账户的特定密钥并点击它,以查看在特定期间内使用此 API 密钥进行的所有登录。输出将包括用于登录的电子邮件和 IP 地址、其成功状态以及事件的日期和时间。

无需 Web 控制面板即为整个 Invapi 账户获取 API 密钥

可以通过利用 用于处理 API 密钥的 API 方法 在不使用 Web 控制面板的情况下获取 API 密钥。这些方法可以从命令行执行或嵌入到 Web 解决方案中

question_mark
Is there anything I can help you with?
question_mark
AI Assistant ×