API 密钥管理

站点管理使您能够为访问 OpenText Application Quality Management API 的外部应用程序创建和管理 API 密钥。

API 密钥概述

API 密钥身份验证为访问系统 API 的外部应用程序提供了安全的身份验证机制。

  • 每个 API 密钥都包含一个客户端 ID 和一个 API 密钥，供应用程序在进行身份验证时使用。
  • 每个 API 密钥都与一个系统用户相关联。因此，当应用程序使用 API 密钥访问系统时，应用程序将受到其关联用户权限的限制。
  • 您只能使用活动 API 密钥来访问系统。

  • 如果您停用或删除用户，用户的 API 密钥也会被删除。

当编写扩展或 API 脚本时，请从管理员处获取客户端 ID 和 API 密钥，然后将其用于身份验证。有关使用 REST 和 OTA 时 API 密钥身份验证的详细信息，请参阅 开发。

返回页首

权限

默认情况下，只有站点管理员 (对于内部部署) 和客户管理员 (对于 SaaS) 可以使用“站点管理”>“用户”>“API 密钥管理”选项卡为用户创建和管理 API 密钥。有关详细信息，请参阅为任何用户创建和管理 API 密钥。

如果您不是站点管理员或客户管理员，您可以通过“站点管理”>“我的设置”>“我的 API 密钥”创建和管理您自己的 API 密钥，具体取决于 APIKEY_SELF_SERVICE_LEVEL 参数的设置。有关详细信息，请参阅创建和管理您自己的 API 密钥。

返回页首

为任何用户创建和管理 API 密钥

作为站点管理员或自定义管理员，您可以为任何活动用户创建、删除、撤销和重新生成 API 密钥。

要创建 API 密钥，请执行以下操作:

  1. 打开“站点管理”>“用户”>“API 密钥管理”。

  2. 单击“添加 API 密钥”，并提供以下信息:

    字段 描述
    API 密钥名 提供密钥的名称。
    所有者

    选择要与密钥关联的用户。用户权限将授予使用此 API 密钥访问系统的任何应用程序。

    SaaS: 可用用户的列表因当前登录的客户管理员而异。
    到期时间

    指定 API 密钥的过期时间。

    您为此 API 设置的过期时间:

    • 覆盖 APIKEY_EXPIRE_DAYS 站点参数全局设置的过期时间。有关详细信息，请参阅站点参数。

    • 应不高于 APIKEY_EXPIRE_DAYS 站点参数的值。
    范围

    为 API 密钥启用或禁用 OData。

    如果要使用 API 密钥身份验证从 OData 连接到项目数据，请为 API 密钥启用 OData。有关详细信息，请参阅对扩展报告的 OData 支持。

  3. 单击“创建”并记下生成的“客户端 ID”和“API 密钥”。

    安全记录生成的客户端 ID 和 API 密钥，并将其提供给关联的用户。客户端 ID 和 API 密钥一旦生成，就无法再次进行检索。如果丢失，请撤销密钥并重新生成。

Note: 您可以为用户创建的 API 密钥的最大数量受 APIKEY_MAX_NUM_PER_USER 站点参数的限制。一旦达到限制，您将无法为用户创建或重新生成 API 密钥。有关参数的详细信息，请参阅站点参数。

要删除 API 密钥，请执行以下操作:

从列表中选择密钥并单击“删除密钥”。

API 密钥所有者将收到有关密钥被删除的通知电子邮件。如果您是具有 API 密钥完全控制权的基本用户，则删除您自己的 API 密钥时不会收到通知。

要撤销 API 密钥，请执行以下操作:

当您要暂时阻止 API 密钥所有者使用 API 密钥访问系统时，请撤销 API 密钥。

要撤销 API 密钥，请从列表中选择密钥并单击“撤销密钥”。

API 密钥所有者将收到有关密钥被撤销的通知电子邮件。如果您是具有 API 密钥完全控制权的基本用户，则撤销您自己的 API 密钥时不会收到通知。

要重新生成已撤销的 API 密钥，请执行以下操作:

您可以重新生成已撤销的 API 密钥，从而重新激活密钥并提供新的用于原始客户端 ID 的 API 密钥。

要重新生成 API 密钥，请从列表中选择密钥并单击“重新生成密钥”。单击复制按钮记下新的 API 密钥。

返回页首

创建和管理您自己的 API 密钥

在允许的情况下，您无需管理员权限即可查看、创建或编辑自己的 API 密钥。

先决条件:

作为基本用户，您是否可以根据 APIKEY_SELF_SERVICE_LEVEL 参数的设置创建和管理自己的 API 密钥。有关详细信息，请参阅APIKEY_SELF_SERVICE_LEVEL。

要创建和管理您自己的 API 密钥，请执行以下操作:

  1. 在“站点管理”的右上角，单击登录用户图标 >“我的设置”。

  2. 单击“我的 API 密钥”选项卡。

  3. 查看您的 API 密钥详细信息或为您的帐户创建 API 密钥。请参见为任何用户创建和管理 API 密钥。

返回页首

筛选 API 密钥

您可以按用户属性 (例如 API 密钥名称、状态和所有者) 筛选 API 密钥。

要筛选 API 密钥，请执行以下操作:

  1. 打开“站点管理”>“用户”>“API 密钥管理”选项卡。

  2. 单击“筛选”。

  3. 指定用于筛选 API 密钥的以下属性，然后单击“筛选”。

    • API 密钥名。显示名称为指定名称的 API 密钥。

    • 客户端 ID显示客户端 ID 为指定 ID 的 API 密钥。

    • Status。显示特定状态 (活动、非活动或已撤销) 的 API 密钥。

    • 所有者。显示所有者为指定所有者的 API 密钥。

    • 创建者。显示由您指定的用户创建的 API 密钥。

    • 到期日期。显示在指定日期之前到期的 API 密钥。

    • 永不过期。 显示永不过期的 API 密钥。

返回页首

API 密钥站点参数

下表列出了与 API 密钥相关的站点参数。作为站点管理员，您可以使用这些参数控制站点级别的 API 密钥行为。

参数 描述
OTA_ACCESS_APIKEY_ONLY

此参数用于控制第三方应用程序是否可以使用用户名和密码通过 OTA API 进行身份验证。
RESTAPI_ACCESS_APIKEY_ONLY 此参数用于控制应用程序是否可以使用用户名和密码通过 REST API 进行身份验证。
RESTAPI_WHITELIST_APIKEY 此参数用于指定可以使用用户名和密码通过 REST API 登录的第三方工具或应用程序的客户端类型。
RESTAPI_DEFAULTLIST_APIKEY 此参数用于指定可以使用用户名和密码通过 REST API 登录的内部工具的客户端类型。
APIKEY_MAX_NUM_PER_USER 此参数用于定义允许每个用户创建的活动 API 密钥的最大数量。默认值是 10。
APIKEY_EXPIRE_DAYS

此参数用于全局指定所有 API 密钥过期的天数。

默认值为 -1，这意味着 API 密钥永不过期。如果 API 密钥单独指定了到期时间，则该 API 密钥的此参数将被覆盖。有关详细信息，请参阅到期时间。
APIKEY_SELF_SERVICE_LEVEL

此参数用于控制所有用户可以在“站点管理”>“我的设置”>“我的 API 密钥”页面中使用其 API 密钥执行哪些操作。

  • admin_only。您无法创建或管理您的 API 密钥。只有站点管理员或客户管理员才能通过“站点管理”>“用户”>“API 密钥管理”为您处理 API 密钥。

  • user_read_only。您无法创建或编辑您的 API 密钥，但可以查看 API 密钥详细信息。

  • user_full_control。您可以完全控制您的 API 密钥，包括创建、查看、撤销、删除和重新生成 API 密钥。

有关详细信息，请参阅站点参数。

返回页首

API 密钥疑难解答

下表列出了您在使用 API 密钥时可能遇到的问题。

问题 解决方案
升级后无法使用现有 API 密钥连接到外部应用程序 联系您的站点管理员，以确保机密数据密码短语和通信安全密码短语与之前版本所使用的密码短语相同。不同版本之间的密码短语不同会导致所有现有 API 密钥的机密无效。

返回页首