
在 Apple 商务管理中创建 API 账户
通过 Apple 校园教务管理和商务管理 API,你可以编辑设备的管理分配信息和查看设备信息。你还可以使用设备的端点,使 App 能够创建自定义报告或导出设备数据。
概览
通过 Apple 校园教务管理和商务管理 API,你可以编辑设备的管理分配信息和查看设备信息。你还可以使用设备的端点,使 App 能够创建自定义报告或导出设备数据。该 API 支持 OAuth 2。通过 OAuth 2,App 通过一组凭证进行身份验证以换取访问令牌,确保向 API 发出经过身份验证的请求。
在使用这些 API 之前,你需要在 Apple 商务管理中创建 API 账户。只有具有管理员职务的用户才可以创建 API 账户。
数据访问
在正确配置 API 账户后,该账户允许 App 访问以下信息:
类别 | 功能 | 描述 |
---|---|---|
设备 | 获取组织设备 | 获取组织中使用自动设备注册进行注册的设备列表。 |
设备 | 获取设备信息 | 获取组织中设备的相关信息,例如设备机型、订单号和部件号。 |
设备管理服务 | 获取设备管理服务 | 获取组织中设备管理服务的列表。 |
设备管理服务 | 获取设备管理服务的设备序列号 | 获取分配给设备管理服务的设备序列号的列表。 |
设备管理服务 | 获取设备的已分配设备管理服务 ID | 获取设备的已分配设备管理服务 ID 信息。 |
设备管理服务 | 获取设备的已分配设备管理服务信息 | 获取设备的已分配设备管理服务信息。 |
设备管理服务 | 获取设备活动信息 | 获取因设备管理操作(例如分配和取消分配)而创建的组织设备活动信息。 |
设备管理服务 | 将设备分配给设备管理服务或从设备管理服务取消分配设备 | 将设备分配给设备管理服务或从设备管理服务取消分配设备。 |
生成私钥
为保持与 Apple 商务管理的安全连接,你需要生成私钥。该密钥的文件名以 .pem 结尾,并且只能生成一次。
创建 API 账户并下载私钥
在 Apple 商务管理
中,通过具有管理员职务的用户登录。
在边栏底部选择你的姓名,选择“偏好设置”
,然后选择“API”。
选择“开始”,输入账户的名称,然后选择“创建”。
执行以下任一操作:
选择“生成私钥”以生成密钥。
该文件会自动下载到你浏览器偏好设置中的文件下载位置;或者,如果没有相应位置,系统会询问存储该文件的位置。
选择“以后”可在以后生成私钥。
选择“管理”可查看创建连接所需的信息。
有关如何创建连接的信息,请参阅 Apple 开发者文稿。