在 Apple Business 建立 API 帳户
概覽
透過 Apple Business 提供的 API，你可以編輯裝置管理的分派、檢視裝置資料、自動化裝置分派流程、將裝置庫存資料整合到第三方平台，或建立自訂儀表板，而無須在入口網站中瀏覽並手動完成以上操作。此 API 支援 OAuth 2，因此 App 可使用一組憑證進行身份認證以換取存取代號，繼而向 API 發出經過認證的請求。
在使用這些 API 之前，你需要在 Apple Business 中建立 API 帳户。只有職務為「機構管理員」的用户才能建立 API 帳户。
附註：你最多可以有 50 個 API 帳户。
資料存取權限
正確設定 API 帳户後，該帳户可允許 App 取用以下資料：
類別 | 權限名稱 | 描述 |
|---|---|---|
裝置 | 查看裝置管理服務、管理預設平台分派和使用 Apple Configurator 加入裝置。 | 取得機構中使用「自動註冊裝置」註冊的裝置列表。 |
裝置 | 查看裝置管理服務、管理預設平台分派和使用 Apple Configurator 加入裝置。 | 取得機構裝置的相關資料，例如裝置型號、訂單編號和零件編號。 |
裝置管理伺服器服務 | 查看裝置管理服務、管理預設平台分派和使用 Apple Configurator 加入裝置。 | 取得機構中裝置管理伺服器服務的列表。 |
裝置管理伺服器服務 | 查看裝置管理服務、管理預設平台分派和使用 Apple Configurator 加入裝置。 | 取得分派至某裝置管理伺服器服務的裝置序號列表。 |
裝置管理伺服器服務 | 查看裝置管理服務、管理預設平台分派和使用 Apple Configurator 加入裝置。 | 取得某裝置所分派的裝置管理伺服器服務 ID 資料。 |
裝置管理伺服器服務 | 查看裝置管理服務、管理預設平台分派和使用 Apple Configurator 加入裝置。 | 取得某裝置所分派的裝置管理伺服器服務資料。 |
裝置管理伺服器服務 | 查看裝置管理服務、管理預設平台分派和使用 Apple Configurator 加入裝置。 | 取得裝置管理動作（例如分派或取消分派）所建立的機構裝置活動資料。 |
裝置管理伺服器服務 | 將裝置分派至裝置管理服務。 | 將裝置分派或取消分派至裝置管理伺服器服務。 |
用户管理服務 | 取得機構中的用户列表。 | |
用户管理服務 | 取得機構中特定用户的資料。 | |
用户群組管理服務 | 取得機構中的用户群組列表。 | |
用户群組管理服務 | 取得機構中特定用户群組的資料。 | |
用户群組管理服務 | 取得獲分派到機構中某一用户群組的用户列表。 | |
「藍圖」 | 查看「藍圖」。 | 取得機構中的「藍圖」列表。 |
「藍圖」 | 管理「藍圖」。 | 在機構中建立「藍圖」。 |
「藍圖」 | 管理「藍圖」。 | 取得機構中某一「藍圖」的相關資料。 |
「藍圖」 | 管理「藍圖」。 | 更新機構中的「藍圖」。 |
「藍圖」 | 管理「藍圖」。 | 刪除機構中的「藍圖」。 |
「藍圖」 | 管理「藍圖」。 | 取得或修改機構中某一「藍圖」內指定類型的成員。 |
設定 (Configuration) | 查看裝置設定。 | 取得機構中的設定列表。 |
設定 (Configuration) | 查看裝置設定。 | 取得機構中某一設定的詳細資料。 |
設定 (Configuration) | 建立、編輯和刪除裝置設定。 | 在 (CUSTOM_SETTING 類型的) 機構中建立設定。 |
設定 (Configuration) | 建立、編輯和刪除裝置設定。 | 在 (CUSTOM_SETTING 類型的) 機構中更新設定。 |
設定 (Configuration) | 建立、編輯和刪除裝置設定。 | 刪除機構中的某一設定。 |
套件 | 使用內置裝置管理來查看和管理裝置。 | 取得機構中的套件。 |
App | 查閱 App。 | 取得機構中已取得許可證的 App。 |
審核事件 | 透過管理員 API 取用審核事件。 | 取得機構的審核事件列表，並按各種條件篩選。審核事件代表機構內的某一動態，例如加入或移除裝置。 |
產生私人密鑰
若要維持與 Apple Business 的安全連線，你需要產生私人密鑰。該密鑰的檔案名稱需以 .pem 結尾，且只需產生一次。
建立新的 API 帳户並下載私人密鑰
在 Apple Business 中，以職務為機構管理員的用户登入。
選擇「新增 API 帳户」，然後輸入用户名稱並選擇其職務，再選擇「下一步」。
請選擇以下其中一項：
選擇「產生並下載」以產生並下載密鑰。
系統會自動將檔案下載至瀏覽器偏好設定中的檔案下載位置；若未設定，系統將詢問儲存位置。
選擇「稍後決定」以稍後產生私人密鑰。
選擇「編輯」以檢視建立連線所需的資訊。
參閱 Apple 開發者文件，了解如何建立連線。
編輯由 Apple Business Manager 或 Apple 商務必備轉移過來的現有 API 帳户
如果你的機構由 Apple Business Manager 或 Apple 商務必備轉移到 Apple Business，並已經擁有 API 帳户，那麼這些帳户現已具備自訂職務。你可以查看和編輯任何 API 帳户資料。
在 Apple Business 中，以職務為機構管理員的用户登入。
選擇現有 API 帳户旁的「編輯」。
如有需要，請選擇以下任何一項操作：
更改帳户名稱
更改職務
自訂職務為「裝置 API 管理員」。如要編輯職務的權限，請參閱「職務和權限簡介」。
將用户端 ID 複製到剪貼簿。
將密鑰 ID 複製到剪貼簿。
撤銷私人密鑰。
選擇「儲存」。
參閱 Apple 開發者文件，了解如何管理連線。