
在「Apple 校務管理」建立 API 帳號
透過「Apple 校務管理」和「Apple 商務管理」的 API,你可以編輯裝置的管理指派項目並查看裝置資訊。你也可以使用裝置的端點,讓 App 能夠建立自訂報告或匯出裝置資料。
概覽
透過「Apple 校務管理」與「Apple 商務管理」的 API,你可以編輯裝置的管理指派項目並查看裝置資訊。你也可以使用裝置的端點,讓 App 能夠建立自訂報告或匯出裝置資料。API 支援 OAuth 2。使用 OAuth 2 時,App 會使用一組憑證進行驗證,以換取存取權杖,對 API 發出經過驗證的請求。
在使用這些 API 之前,需先在「Apple 校務管理」建立 API 帳號。只有職務為管理員及機構經理的使用者,才能建立 API 帳號。
資料存取
正確設定 API 帳號後,該帳號可以允許 App 存取以下資訊:
類別 | 功能 | 說明 |
---|---|---|
裝置 | 取得機構裝置 | 取得註冊時使用自動裝置註冊的機構內部裝置列表。 |
裝置 | 取得裝置資訊 | 取得機構內部裝置的相關資訊,例如裝置型號、訂單編號與部件編號。 |
裝置管理伺服器服務 | 取得裝置管理伺服器服務 | 取得機構內部裝置管理伺服器服務的列表。 |
裝置管理伺服器服務 | 取得裝置管理伺服器服務的裝置序號 | 取得指派給裝置管理伺服器服務的裝置序號列表。 |
裝置管理伺服器服務 | 取得裝置的已指派裝置管理伺服器服務 ID。 | 取得裝置的已指派裝置管理伺服器服務 ID 資訊。 |
裝置管理伺服器服務 | 取得裝置的已指派裝置管理伺服器服務資訊 | 取得裝置的已指派裝置管理伺服器服務資訊。 |
裝置管理伺服器服務 | 取得裝置動作資訊 | 取得由裝置管理伺服器動作(例如指派或取消指派)所產生的機構裝置動作資訊。 |
裝置管理伺服器服務 | 將裝置指派或取消指派至至裝置管理伺服器服務 | 將裝置指派或取消指派至至裝置管理伺服器服務。 |
產生私人密鑰
為了維持與「Apple 校務管理」的安全連線,你需要產生私人密鑰。該密鑰的檔案名稱結尾為 .pem,只需產生一次。
建立 API 帳號並下載私人密鑰
以職務為管理員或機構經理的使用者身分,登入「Apple 校務管理」
。
在側邊欄底部選取你的姓名,接著選取「偏好設定」
,然後選取 API。
選取「開始使用」,輸入帳號名稱,然後選取「建立」。
執行下列其中一項步驟:
選取「產生私人密鑰」來產生密鑰。
檔案會自動下載到瀏覽器偏好設定的檔案下載位置,如果未設定下載位置,系統會詢問要將檔案儲存在哪裡。
選取「稍後」即可之後再產生私人密鑰。
選取「管理」即可查看建立連線的所需資訊。
請參閱 Apple 開發者文件,瞭解如何建立連線。