API 密钥应用程序

API 密钥用于为外部客户机启用入站机器对机器集成。 API 密钥可由 OSLC 和 REST API 使用，也可用作管理集成框架的一部分。

在机器到机器集成中，外部机器在不使用浏览器的情况下与 Manage 系统中的 Manage 数据进行交互。 API 密钥是本机形式的认证，无需外部存储库来进行密钥存储。

缺省情况下，所有 API 密钥都在存储器中加密。此设置由 mxe.secureapikey 属性控制。

为 REST API 添加 API 密钥

将 API 密钥分配给外部客户机时，外部客户机可以使用 API 密钥作为 apikey 查询参数或 REST API 调用中的 apikey 请求头来访问 Manage 系统中的数据并与之进行交互。使用 API 密钥的 REST API 调用不会创建持久性服务器连接，并且 API 密钥必须包含在外部客户提交的所有 REST API 请求中。

要使用 API 密钥，请从菜单转至集成 > API 密钥应用程序。

使用外部创建的 API 密钥

您可以使用外部创建的 API 密钥作为 Maximo® Manage中的 API 密钥。使用 MXAPIAPIKEY REST API 创建此类型的 API 密钥，并使用 "apikey" json 属性提供生成的 API 密钥，如以下代码中所示:

POST /oslc/os/mxapiapikey
{
 "apikey":"<outside generated apikey>",
 "expiration":-1
}

安全访问

作为系统管理员，必须先同步外部客户机的管理用户，然后才能为这些客户机创建 API 密钥。与 API 密钥关联的许可权由关联用户的许可权确定。可以从集成下的 API 密钥应用程序创建和配置 API 密钥。

您还可以指定仅使已登录用户能够创建 API 密钥的安全性。要将 API 密钥的创建限于已登录用户，请转至“系统属性”应用程序并对 mxe.apikeyforloggedinuser 属性进行过滤。在全局值字段中，指定 1 并保存记录。选择实时刷新以立即应用值。

要禁用外部客户机对 Manage 系统的访问权，您可以删除关联的 API 密钥，但外部客户机仍可以使用另一个已配置的认证系统来访问 Manage 系统。如果 API 密钥损坏，请删除该密钥并为该用户创建其他密钥。