跳到主要内容 跳到补充内容

管理 API 密钥

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

使用 API 密钥连接 Qlik Cloud API。

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

示例:使用 Postman 连接到 Qlik API。

执行以下操作:

  1. 启动 Postman

  2. 将 HTTP 方法设置为 GET

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

    例如,要列出租户的全部空间:

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

  4. 验证选项卡中,选择持有人令牌作为验证类型

  5. 令牌字段中输入 API 密钥。

  6. 单击发送

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

在租户中启用 API 密钥

默认情况下,会禁用 API 密钥生成。租户管理员必须在租户中启用 API 密钥,以允许用户生成它们。

执行以下操作:

  1. Administration 活动中心中,转到设置
  2. API 密钥下,选择启用 API 密钥
  3. 根据需要调整以下设置:

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

    • 更改每个用户活动 API 密钥的最大数目:此限制仅适用于新 API 密钥。如果达到限制,将拒绝创建额外的 API 密钥。可以设置的最大值为 1000。
    信息注释您可能需要刷新浏览器,以查看用户配置文件页面上 API 密钥部分中反映的更改。
  4. 若要开始生成 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 密钥活动,识别任何可疑行为。

本页面有帮助吗?

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