管理 API 密钥 | Qlik Cloud帮助
跳到主要内容 跳到补充内容

管理 API 密钥

API 密钥是用于身份验证的唯一标识符,允许用户、开发人员或程序安全地访问 API。它们对于跟踪和控制 API 的使用至关重要,有助于防止滥用和确保通信安全。

video thumbnail

使用 API 密钥连接到 Qlik Cloud API

您可以使用 API 密钥与 Qlik REST API 参考进行交互。可以使用 Postman 或 qlik-cli 等工具进行 API 访问。有关更多信息,请参阅 Qlik API 概述qlik-cli

信息注释

API 凭据提供对 Qlik Cloud 的直接编程访问,并且不限于用户界面中可用的工作流。使用最小特权原则分配角色和 OAuth 范围。对待服务帐户和 API 凭据应与对待管理员凭据同等谨慎。有关详细信息,请参阅 API 访问控制和信任边界

示例:使用 Postman 连接到 Qlik API

执行以下操作:

  1. 启动 Postman

  2. 将 HTTP 方法设置为 GET

  3. 输入 Qlik Cloud API 端点的 URL。

    例如,要列出租户中的所有空间:

    https://your-tenant.eu.qlikcloud.com/api/v1/spaces

  4. Auth 选项卡上,选择 Bearer Token 作为 Auth Type

  5. Token 字段中输入您的 API 密钥。

  6. 单击 Send

如果请求成功,API 将返回 JSON 响应。在此示例中,响应将包含空间列表。

配置 API 密钥设置

执行以下操作:

  1. Administration 活动中心,转到 设置 页面。

  2. 选择 功能控制 选项卡。
  3. API 密钥 部分中,根据需要调整以下设置:

    • 更改最大令牌过期时间:设置新生成的 API 令牌的过期时间。现有的 API 密钥将保留其原始过期值。此值没有上限。

    • 更改每个用户的最大激活 API 密钥数:设置用户可以拥有的 API 密钥数量限制。此限制仅适用于新密钥。如果达到限制,用户将无法创建其他密钥。最大值为 1000。

您可能需要刷新浏览器才能在个人设置页面的 API 密钥 部分中看到反映的更改。

生成和管理 API 密钥

生成 API 密钥

要生成新的 API 密钥,您必须具有包含 管理 API 密钥 权限的自定义角色,或者必须在 用户默认 设置中启用该权限。

执行以下操作:

  1. 单击您的用户配置文件图标,然后选择 设置

  2. 转到 API 密钥 部分,然后单击 生成新密钥

  3. 提供描述并设置 API 密钥的过期时间。

  4. 单击 生成 以创建密钥。

  5. 复制生成的 API 密钥并安全地存储它。请注意,以后无法检索该密钥。

编辑 API 密钥

您可以在创建后更改 API 密钥的名称。

删除 API 密钥

信息注释删除 API 密钥是永久性的,无法撤消。确保此操作不会中断依赖该密钥的任何正在进行的进程或集成。

执行以下操作:

  1. 单击您的用户配置文件图标,然后选择 设置

  2. 转到 API 密钥 部分。

  3. 单击要删除的 API 密钥旁边的 更多,然后选择 删除

  4. 要删除所有密钥,请单击密钥列表上方的 全部删除

监控和撤销 API 密钥

您可以在 Administration 活动中心的 API 密钥 部分中查看与您的租户关联的所有 API 密钥。您可以按名称、ID 或所有者搜索密钥。

API 密钥状态

API 密钥可以具有以下状态:

  • 激活API 密钥当前正在使用中。
  • 已过期:已达到到期日期。
  • 已撤销API 密钥已被撤销,无法再使用。

撤销 API 密钥

作为租户管理员,主动监控 API 密钥活动对于维护安全性至关重要。如果检测到可疑活动,您可以撤销 API 密钥。

信息注释撤销 API 密钥会立即将其停用,从而影响依赖它的任何正在进行的进程或集成。撤销是不可逆的;已撤销的 API 密钥无法重新激活。

执行以下操作:

  1. Administration 活动中心,转到 事件

  2. 查找任何可疑活动,例如过度使用特定 API 密钥。

  3. 单击事件旁边的 向下箭头 以展开其详细信息并复制 API 密钥 ID。

  4. 转到 API 密钥 部分,并使用其 ID 搜索 API 密钥。

  5. 单击密钥旁边的 更多,然后选择 撤销。您只能撤销状态为“激活”的密钥。

  6. 要撤销多个 API 密钥,请在表中选择它们,然后单击右上角的 撤销

API 密钥管理最佳实践

  • 对密钥保密:安全地存储 API 密钥,避免将其暴露在公共代码存储库中。

  • 定期重新生成:定期重新生成您的 API 密钥以增强安全性。

  • 监控使用情况:定期检查 API 密钥活动以识别任何可疑行为。

本页面有帮助吗?

如果您发现此页面或其内容有任何问题 – 打字错误、遗漏步骤或技术错误 – 请告诉我们!