生成用于认证的 API 密钥

有了 API 密钥，您就可以通过脚本或应用程序自动验证IBM watsonx。 您的 API 密钥与您的凭证相关联，并且特定于您。 通过 API 密钥，您可以在不输入密码的情况下进行认证。

您可以生成:

您也可以使用 Get API key 端点以编程方式生成新的 API 密钥。 不过，该端点需要 ZenApiKey 授权令牌或 Bearer 令牌，因此不建议使用。

您的平台 API 密钥使脚本和应用程序能够访问您登录IBM watsonxWeb 客户端时通常能够访问的所有内容。 实例 API 密钥仅允许访问从中生成实例的特定实例。

在生成 API 密钥之前，请考虑以下因素:
需要什么级别的访问权?
作为安全最佳实践，建议您提供对脚本或应用程序所需的最少访问权。 例如，如果脚本仅需要与特定服务实例进行交互，请为该服务实例生成 API 密钥。
我可以生成哪种类型的密钥?
某些服务不支持实例级别的 API 密钥。 如果无法生成特定于服务的 API 密钥，那么必须使用平台 API 密钥。
重要信息: 确保将 API 密钥存储在安全的位置。 如果丢失 API 密钥，那么需要创建新密钥并更新使用该密钥的任何脚本或应用程序。

平台 API 密钥

使用平台 API 密钥，您可以访问登录IBM watsonxWeb 客户端时通常能够访问的所有内容。

要生成平台 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授权令牌，请使用以下方法之一。