生成 API 密钥以进行认证

通过 API 密钥，您可以从脚本或应用程序中自动 IBMSoftware Hub 向 进行身份验证。 您的 API 密钥与您的凭证相关联，并且特定于您。 使用 API 密钥，您无需输入密码即可完成身份验证。

您可以生成：

您还可以通过调用 API Get API key 端点来程序化地生成新的 API 密钥。 然而，此端点需要授权 ZenApiKey 令牌或 Bearer 令牌，因此不建议使用。

您的平台 API 密钥允许脚本和应用程序访问您登录 Web IBMSoftware Hub 客户端时通常能够访问的所有内容。 实例 API 密钥仅允许访问其所属的特定实例。

生成 API 密钥之前，请考虑以下因素：
需要何种访问级别？
作为安全性最佳实践，建议您向脚本或应用程序提供需要的最低访问级别。 例如，如果脚本仅需要与特定服务实例交互，请为该服务实例生成 API 密钥。
我可以生成哪种类型的密钥？
一些服务不支持实例级别 API 密钥。 如果无法生成特定于服务的 API 密钥，必须使用平台 API 密钥。
重要说明：务必将 API 密钥存储在安全的地方。 若丢失 API 密钥，您需要创建新密钥，并更新所有使用该密钥的脚本或应用程序。

平台 API 密钥

通过平台API密钥，您可以访问登录 Software HubIBM Web客户端时通常能够访问的所有功能。

要生成平台 API 密钥：

  1. 登录 Web 客户机。
  2. 从工具栏中，单击您的头像。
  3. 点击个人资料和设置。
  4. 点击 API 密钥 > 生成新密钥。
  5. 点击生成。
  6. 单击复制并将密钥保存在安全的位置。 如果丢失此密钥，将无法恢复。

如果丢失 API 密钥，请重复上述步骤以生成新的 API 密钥。 旧的 API 密钥将变为无效，并且在您提供新的 API 密钥之前，任何应用程序或脚本都无法向平台认证。

如果您认为自己的 API 密钥已泄露：

  1. 登录 Web 客户机。
  2. 从工具栏中，单击您的头像。
  3. 点击个人资料和设置。
  4. 点击 API 密钥 > 撤销当前密钥。
  5. 点击撤销。

使用该密钥的任何应用程序或脚本将无法向平台认证。

实例 API 密钥

如果您有权访问服务的特定实例，那么您可以生成 API 密钥以仅访问该服务实例。

限制： 此功能可能并非适用于所有服务。

要生成实例 API 密钥：

  1. 登录 Web 客户机。
  2. 从导航菜单中，选择服务 > 实例。
  3. 单击您要为其生成 API 密钥的实例的名称。
  4. 点击实例API密钥 > 生成API密钥。
  5. 点击生成。
  6. 单击复制并将密钥保存在安全的位置。 如果丢失此密钥，将无法恢复。

如果丢失 API 密钥，请重复上述步骤以生成新的 API 密钥。 旧的 API 密钥将变为无效，并且在您提供新的 API 密钥之前，任何应用程序或脚本都无法向实例认证。

如果您认为自己的 API 密钥已泄露：

  1. 登录 Web 客户机。
  2. 从导航菜单中，选择服务 > 实例。
  3. 单击您要为其撤销当前 API 密钥的实例的名称。
  4. 点击实例 API 密钥 > 撤销 API 密钥。
  5. 点击撤销。

使用该密钥的任何应用程序或脚本将无法向实例认证。

API 令牌

要生成 API 授权令牌，请使用以下任一方法。