將 UEM 功能與 REST API 搭配使用

您可透過將 REST API 與 UEM 基礎結構整合並協助連線，以設定外部應用程式使用 Workspace ONE UEM 的核心產品功能。您也可以選取最接近您資料中心的 OAuth Token URL 來驗證 API 呼叫。

開始使用 REST API

使用簡化的 REST 軟體架構，Workspace ONE UEM REST API 目前支援多種功能，包括企業群組、主控台管理、行動應用程式、行動裝置、電子郵件、註冊使用者、設定檔、智慧群組和使用者群組管理.

使用以 REST 為基礎的 API 可為企業提供多個優點，包括消除了在內部開發應用程式所花費的成本和時間。Workspace ONE UEM REST API 可完全隨時與企業伺服器、程式和處理程序進行整合。Workspace ONE UEM REST API 更有效率，可以順利執行，並且可輕鬆地與企業進行品牌化。這些 API 適用於應用程式開發人員。本指南有助於瞭解 API 程式庫的設計和架構，並促進自訂開發以及與 Workspace ONE UEM 整合。

存取 API 文件

透過導覽至 Workspace ONE UEM API 說明頁面來檢視詳細的 API 說明文件。

1. 以管理員身分登入 Workspace ONE UEM Console。
2. 在瀏覽器的位址列中，將 URL 中的「cn」替換為「as」，然後將 /api/help 附加到 .com 之後。

例如，適用於 SaaS 環境的 URL 的 API 文件...

https://cn4855.awmdm.com

...為...

https://as4855.awmdm.com/api/help

支援 OAuth 2.0 的資料中心和 Token URL

Workspace ONE UEM 支援 OAuth 2.0 業界標準通訊協定，以進行 REST API 呼叫的安全驗證和授權。Workspace ONE Token 服務是 OAuth 驗證的 Token 簽發者，僅能在 SaaS 環境中獲得支援。Token URL 為區域特定。

建立 API 命令適用的 OAuth 用戶端 (SaaS)

您可以建立僅在 SaaS 環境中獲得支援，API 命令適用的 OAuth 用戶端。透過執行下列步驟，針對您的 SaaS 環境建立 OAuth 用戶端。

1. 導覽至群組與設定 > 組態。

2. 在標示為「輸入名稱或類別」的搜尋文字方塊中輸入 OAuth。

3. 選取結果中顯示的 OAuth 用戶端管理。OAuth 用戶端管理畫面即會顯示。

4. 選擇新增按鈕。

5. 輸入名稱、說明、組織群組，以及角色。

   附註：如要進一步瞭解關於所選角色的特定 REST API 權限，請參閱本主題中建立可以使用 REST API 的角色區段。

6. 確定狀態為啟用。

7. 選取儲存。

8. 重要：將用戶端 ID 和用戶端密碼複製到剪貼簿，然後在關閉此畫面之前加以儲存。選取複製圖示 ()，將用戶端密碼傳送至剪貼簿。

   選取關閉後，您無法回到此處擷取這些資訊。

9. 使用用戶端 ID、用戶端密碼和 Token URL，產生以下格式的存取 Token：

   HTTP 要求

   API 呼叫：POST {來自前述區段的地區特定 Token URL}

   輸入參數

   參數	必要	說明
   tenant_url	是 (URL)	租用戶的主機名稱
   grant_type=client_credentials	是 (內文)	取得存取 Token 的必要條件
   application/x-www-form-urlencoded	是 (標頭)	編碼的格式
   自動化：基本	是 (標頭)	您必須傳遞 client_id:Client_secret 的 Base64 編碼字串

10. 使用傳回的存取 Token，將未來的 API 要求授權至 Workspace ONE UEM API 伺服器。您必須採用以下方式在要求求標頭中格式化存取 Token。

    API 呼叫：{UEM API}

    鍵	值
    授權	{存取 Token}

建立可以使用 REST API 的角色

每個 API 呼叫都具有相應的資源 (或權限)，您必須將其包含在指派給 OAuth 用戶端的角色中。因此，要在您指派的角色中納入的權限，與您要執行的 API 呼叫類型一致。

使用下表中的資訊，以便選擇必須將哪些權限包含在您指派的角色中。然後，存取身份式的存取權中標題為建立管理員角色一節，瞭解有關建立該角色的說明。