
在 Apple 商务中创建 API 账户
概览
通过 Apple 商务 API,你可以编辑设备的管理分配信息、查看设备信息、自动化设备分配流程、将设备库存数据导入第三方平台,以及搭建自定义面板。若不使用 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 开发者文稿。
编辑从 Apple 商务管理或 Apple 商务必备中迁移的现有 API 账户
如果你的组织从 Apple 商务管理或 Apple 商务必备迁移到了 Apple 商务,而且你已经拥有 API 账户,系统会给这些账户分配自定义职务。你可以查看并编辑 API 账户的任意信息。
在 Apple 商务中,使用职务为组织管理员的用户账户登录。
点按现有 API 账户旁边的“编辑”。
如有必要,执行以下任一操作:
更改账户名称
更改职务
这个自定义职务为“设备 API 管理员”。若要编辑职务和权限,请参阅“职务和权限简介”。
将客户端 ID 拷贝到剪贴板
将密钥 ID 拷贝到剪贴板
撤销专用密钥
选择“保存”。
有关如何管理连接的信息,请参阅 Apple 开发者文稿。