生成 API 键

要调用 Concert API，您必须使用有效的 API 密钥来验证您的请求，您可以从 Concert 用户界面创建该密钥。 您可以将 Concert API 用于一次性或自动数据摄取或其他受支持的功能。

警告：API 密钥是唯一标识符，可授予访问 Concert 实例和配置某些方面的权限。 始终安全地存储 API 密钥，并限制授权个人的访问权限，以防止未经授权的请求或与数据安全相关的风险。 如果 API 密钥丢失，则无法恢复；在这种情况下，必须生成一个新密钥。

指示信息

执行以下指令，在Concert用户界面中生成新的 API 密钥。

  1. 使用您的凭据或配置的 SSO 和多因素身份验证登录 "Concert用户界面。
  2. 单击主导航标题右上角的用户图标（圆圈），然后选择 API 密钥。
  3. 单击 生成 API 密钥。
    注意：如果您已经创建了一个 API 密钥，系统会提示您在生成新密钥前撤销该密钥。
  4. 记录API 密钥值和API 密钥用法详细信息，并将其存储在安全位置。
    警告：关闭对话框后将无法查看 API 密钥。

API 密钥用法示例包含您需要在 API 标头中包含的关键信息，包括

  • API 密钥类型： C_API_KEY （用于 SaaS 和虚拟机部署）或 ZenAPIKey （用于 Concert 部署在使用 IBM Cloud Pak® foundational services 部署的 OCP 集群上）。 该值必须位于身份验证标头中的 API 密钥秘密之前。
  • InstanceId：您的 Concert 实例的唯一 ID。

生成有效的 API 密钥后，就可以开始使用它来验证请求了。 有关调用应用程序接口参考和认证API 所需的各种自定义标头的详细信息，请参阅Concert。

有关端点和请求的完整索引，请参阅https://developer.ibm.com/apis/catalog/concert--ibm-concert-api。