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

管理 API 密钥

API 密钥充当身份验证的唯一标识符,允许用户、开发人员或程序安全地访问 APIAPI 密钥通常用于跟踪和控制 API 的使用,以防止滥用。

提示注释

如果您的租户正在使用新的导航体验,则管理活动中心将替换 管理控制台

有关更多信息,请参阅新平台导航

API 密钥概览

管理控制台API 密钥部分,您可以查看与租户关联的所有 API 密钥。您可以按名称、ID 或所有者搜索密钥。

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

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

租户管理员可以启用 API 密钥生成,以及监视和吊销 API 密钥。若要生成、编辑或删除 API 密钥,需要开发人员角色。租户管理员可以将此角色分配给用户,包括他们自己。

在租户中启用 API 密钥

默认情况下,API 密钥处于禁用状态。租户管理员可以在租户中启用 API 密钥。

执行以下操作:

  1. 管理控制台 中,转到设置
  2. 找到 API 密钥部分,然后选择启用 API 密钥
  3. 如果需要,请调整以下设置:
    • 更改最大令牌过期时间:修改新生成的令牌的过期时间。现有 API 密钥保留其原始过期值。该值没有最大限制。

      信息注释您可能需要刷新浏览器,以查看用户配置文件页面上 API 密钥部分中反映的对此值的更改。
    • 更改每个用户活动 API 密钥的最大数目:此设置仅影响新的 API 密钥。如果达到限制,将拒绝创建新的 API 密钥。最大值为 1000。
  4. 若要开始生成 API 密钥,请单击生成新密钥。这会将您重定向到用户配置文件页面上的 API 密钥部分,在该处您可以创建新的密钥。

生成 API 密钥

您可从应用中心生成 API 密钥。开始之前,请确保满足以下要求:

  • 您有一个活动许可证。

  • 管理控制台 中启用 API 密钥
  • 您具有开发人员角色。

执行以下操作:

  1. 单击右上角的用户配置文件图标,然后选择配置文件设置。

  2. API 密钥部分中,单击生成新密钥

  3. 提供 API 密钥的说明和过期时间。

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

  5. 立即复制生成的 API 密钥并将其安全存储。以后无法检索密钥。

创建之后,您可以编辑 API 密钥的名称,也可以根据需要将其删除。

使用 API 密钥,您可以使用类似 Postman 的工具来探索 qlik.dev 上的 REST API 引用,或者安装 qlik-cli 以直接从命令行访问 Qlik 功能。有关更多信息,请参阅 Qlik APIqlik-cli 的概述

监视和撤销 API 密钥

作为租户管理员,出于安全目的监控 API 关键活动至关重要。如果检测到可疑活动,您可以撤销 API 密钥。

请记住,撤销 API 密钥将立即停用它,从而影响任何依赖它的正在进行的流程或集成。吊销是不可逆的,并且已吊销的 API 密钥不能被重新激活。

执行以下操作:

  1. 管理控制台 中,转到事件部分。

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

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

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

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

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

删除 API 密钥

删除 API 密钥会将它们从系统中永久删除。删除 API 密钥是不可逆的,将立即删除其访问权限。确保此操作不会中断任何依赖密钥的正在进行的过程或集成。

您需要开发人员角色才能删除 API 密钥。

执行以下操作:

  1. 单击右上角的用户配置文件图标,然后选择配置文件设置。

  2. 选择 API 密钥部分。

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

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

本页面有帮助吗?

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