透過 REST API 與外部應用程式進行通訊

您可以搭配使用 REST API 與用戶端型工具,與任何自訂延伸規格或外部應用程式中的產品進行互動。

Maximo® Asset Management中,「遠端方法呼叫 (RMI)」可用來從自訂延伸或外部應用程式與產品互動。 不過,在 Maximo Manage的完全併櫃環境中, Maximo 伺服器處理程序外部不支援 RMI。 您可以搭配使用 REST API(而非 RMI)與自訂延伸規格或外部應用程式中的產品以進行互動。

為了協助使用 REST API,產品提供範例 HTTP 用戶端,該用戶端屬於 com.ibm.tivoli.maximo.oslc.provider.RestClient 類別。 此範例 HTTP 用戶端是許多有用方法及其他程式庫的程式庫。

REST API 有助於與產品整合

產品中的 REST API 為整合管理者提供下列主要好處:
  • REST API 用戶端可以用您選擇的語言來撰寫,而使用 RMI 時,您只能以 Java™ 語言來撰寫。
  • REST API 透過使用物件結構,簡化自訂作業及與用戶端應用程式的整合。
  • REST API 可以將 API 金鑰用於鑑別及授權。 可以使用任何基本 HTTP 用戶端完成與產品的所有通訊,例如產品隨附的範例 RestClient HTTP 用戶端。
  • 精心設計的 REST API 呼叫提供高可調整性,並產生較少的網路資料流量。 下列各節說明設計及編碼 REST API 呼叫的數個方法。

REST API 編碼選項

REST API 編碼通常處於相當高層次,但是如果您需要精度,則產品提供選項以讓程式碼精細。 您可以將 API 呼叫編碼為多個 REST 呼叫、大量 REST 呼叫或使用自動化 Script 的 REST 呼叫。

根據您針對用戶端編碼 REST API 互動方式,產生的網路資料流量可能有所不同。 如果未正確地編碼 REST API 互動,則可能會對用戶端及產品效能產生負面影響。

多個個別 REST 呼叫

如果您要從較早產品版本中使用 RMI 移動,則可以一對一地將 RMI 呼叫轉換為 REST 呼叫。 不過, RMI 容許在隨 Maximo Manage提供的 Java SDK 中使用精細 API ,而 REST API 是更高層次。 此外,並非每個 RMI 呼叫都有對等的 REST API 呼叫,因為 REST API 無法用於產品的所有 Java SDK。

如果您因為網路呼叫的數目而使用多個 REST 呼叫進行編碼,則網路資料流量可能較高。

大量 REST 呼叫

利用大量 REST 呼叫,您可以為一個呼叫撰寫程式碼,該呼叫會對一組符合標準的記錄執行動作。 大量 REST 呼叫比多個個別 REST 呼叫提供更好的網路效能。 然而,您的精細 RMI 呼叫可能發生缺少 REST API 相當項目的問題。

使用自動化 Script 的 REST 呼叫

使用自動化 Script 的 REST 呼叫提供最好的精度及網路效能。 使用此方法,您可以存取完整 Java SDK ,但其他方法無法存取完整 Java SDK。

您在「自動化 Script」應用程式中寫入自動化 Script,並使用 REST 用戶端呼叫該 Script。 Scripting 架構將 API 查詢參數歸入 Script。 可以透過許多語言寫入自動化 Script。

使用自動化 Script 編碼 REST API 也可讓您有組織地建立 REST API,以適合您的環境,並且可以在其他位置使用。