OpManager REST API

OpManager 提供 REST API 用于向 OpManager 添加数据和从中获取数据。通过这些 API，您可以将 OpManager 与第三方 IT 管理/服务台软件进行集成。

注意：本文档提供了用于将 OpManager 数据发送到外部系统的 REST API 列表。

若要了解如何将外部网站或第三方工具的数据导入到 OpManager 中，请点击此处。

OpManager REST API 如何工作？

API 通过 API 密钥进行身份验证。每个 OpManager 账户都有唯一的 API 密钥，所有 API 请求都必须提供该密钥。了解如何启用或禁用 REST API 密钥

如何查看 API 密钥？

要查看或复制 API 密钥，请在 OpManager Web 客户端中进入“快速链接 > REST API Key”选项。（快速链接位于右上角的齿轮图标）

如何发送 apiKey？

基于请求参数的 apiKey 身份验证方式已被弃用。在版本 128100 之前，apiKey 可以通过请求参数发送。从版本 128100 起，apiKey 可以通过请求头或请求参数发送。

注意：基于请求参数的 apiKey 身份验证方式即将停止支持。以下 URL 只能通过请求头发送 apiKey 进行调用。对于这些 URL，通过请求参数进行 apiKey 身份验证将不再生效。

带请求头的示例配置：

启用 / 禁用 REST API 访问

从版本 127131 开始，新增了启用/禁用 REST API 的选项。

有哪些变化？

• 在“用户管理”中新创建的用户，默认禁用 REST API 访问。拥有全部模块和设备访问权限的管理员可以在“用户管理”中编辑用户，并根据需要启用 REST API 访问。



• 如果为用户启用了 RestApikey 访问，“快速链接”中的 REST API 菜单将显示 RestApikey，且仅当用户启用了 REST API 访问时，才允许外部 REST API 调用。



• 如果禁用了 REST API 访问，“快速链接”中的 REST API 菜单将显示“请联系管理员用户”。