
在「Apple 商務」中建立 API 帳號
概覽
透過「Apple 商務」API,你可以編輯裝置的管理指派項目、查看裝置資訊、將裝置指派工作流程自動化、將裝置庫存資料整合進第三方平台,或建立自訂儀表板,而不必在入口網站中瀏覽並手動操作這些作業。API 支援 OAuth 2,因此 App 會使用一組憑證進行驗證,以換取存取權杖,進而對 API 發出經過驗證的請求。
在使用這些 API 之前,需先在「Apple 商務」建立 API 帳號。只有職務為「機構管理員」的使用者,才能建立 API 帳號。
【注意】你最多可以有 50 個 API 帳號。
資料存取
正確設定 API 帳號後,該帳號可以允許 App 存取以下資訊:
類別 | 權限名稱 | 說明 |
|---|---|---|
裝置 | 檢視裝置管理服務、管理預設平台指派和使用 Apple Configurator 新增裝置。 | 取得註冊時使用自動裝置註冊的機構內部裝置列表。 |
裝置 | 檢視裝置管理服務、管理預設平台指派和使用 Apple Configurator 新增裝置。 | 取得機構內部裝置的相關資訊,例如裝置型號、訂單編號與零件編號。 |
裝置管理服務 | 檢視裝置管理服務、管理預設平台指派和使用 Apple Configurator 新增裝置。 | 取得機構內部裝置管理服務的列表。 |
裝置管理服務 | 檢視裝置管理服務、管理預設平台指派和使用 Apple Configurator 新增裝置。 | 取得指派給裝置管理服務的裝置序號列表。 |
裝置管理服務 | 檢視裝置管理服務、管理預設平台指派和使用 Apple Configurator 新增裝置。 | 取得裝置的已指派裝置管理服務 ID 資訊。 |
裝置管理服務 | 檢視裝置管理服務、管理預設平台指派和使用 Apple Configurator 新增裝置。 | 取得裝置的已指派裝置管理服務資訊。 |
裝置管理服務 | 檢視裝置管理服務、管理預設平台指派和使用 Apple Configurator 新增裝置。 | 取得由裝置管理動作(例如指派或取消指派)所產生的機構裝置動作資訊。 |
裝置管理服務 | 將裝置指派給裝置管理服務。 | 將裝置指派或取消指派至裝置管理服務。 |
使用者管理服務 | 取得機構中的使用者列表。 | |
使用者管理服務 | 取得機構中特定使用者的相關資訊。 | |
使用者群組管理服務 | 取得機構中的使用者群組列表。 | |
使用者群組管理服務 | 取得機構中特定使用者群組的相關資訊。 | |
使用者群組管理服務 | 取得指派給機構中某一使用者群組的使用者列表。 | |
預設集 | 檢視預設集。 | 取得機構中的預設集列表。 |
預設集 | 管理預設集。 | 在機構中建立預設集。 |
預設集 | 管理預設集。 | 取得機構中某一預設集的相關資訊。 |
預設集 | 管理預設集。 | 更新機構中的預設集。 |
預設集 | 管理預設集。 | 刪除機構中的預設集。 |
預設集 | 管理預設集。 | 取得或修改機構中某一預設集內的指定類型成員。 |
設定 | 檢視裝置設定。 | 取得機構中的設定列表。 |
設定 | 檢視裝置設定。 | 取得機構中某一設定的詳細資訊。 |
設定 | 建立、編輯和刪除裝置設定。 | 在(CUSTOM_SETTING 類型的)機構中建立設定。 |
設定 | 建立、編輯和刪除裝置設定。 | 在(CUSTOM_SETTING 類型的)機構中更新設定。 |
設定 | 建立、編輯和刪除裝置設定。 | 刪除機構中的某一設定。 |
套件 | 使用內建的裝置管理來檢視和管理裝置。 | 取得機構中的套件。 |
App | 檢視 App。 | 取得機構中獲得許可的 App。 |
稽核事件 | 透過管理員 API 存取稽核事件。 | 取得機構的稽核事件列表,並依照各種條件篩選。稽核事件代表機構內的某一動作,例如新增或移除裝置。 |
產生專用密鑰
為了維持與「Apple 商務」的安全連線,你需要產生專用密鑰。該密鑰的檔案名稱結尾為 .pem,只需產生一次。
建立新的 API 帳號並下載專用密鑰
在「Apple 商務」中,以具備「機構管理員」職務的使用者身分登入。
選取「新增 API 帳號」、輸入使用者名稱和職務,然後選取「下一步」。
選擇下列其中一項操作:
選取「產生並下載」以產生並下載金鑰。
檔案會自動下載到瀏覽器偏好設定的檔案下載位置,如果未設定下載位置,系統會詢問要將檔案儲存在哪裡。
選取「稍後再說」即可之後再產生專用密鑰。
選取「編輯」即可查看建立連線的所需資訊。
請參閱 Apple Developer 說明文件,瞭解如何建立連線。
編輯從「Apple 商務管理」或「Apple 商務必備」移轉而來的現有 API 帳號
如果貴機構是從「Apple 商務管理」或「Apple 商務必備」移轉至「Apple 商務」,並具備現有的 API 帳號,這些帳號現在將具備自訂的職務。你可以檢視和編輯任何 API 帳號資訊。
在「Apple 商務」中,以具備「機構管理員」職務的使用者身分登入。
選取現有 API 帳號旁邊的「編輯」。
如有需要,請選擇下列其中一項操作:
更改帳號名稱。
更改職務。
自訂職務為「裝置 API 經理」。若要編輯職務的權限,請參閱〈職務與權限簡介〉。
將「用戶端 ID」複製到剪貼板。
將「密鑰 ID」複製到剪貼板。
撤銷專用密鑰。
選取「儲存」。
請參閱 Apple Developer 說明文件,瞭解如何管理連線。