使用入门

App Store Connect API

App Store Connect API 是一个 REST API,可以自动执行 App Store Connect 中的部分任务。

你可以针对不同职能生成 API 密钥以用于账户中的所有 App,也可以为单个 App Store Connect 用户生成密钥。App Store Connect API 密钥专用于 App Store Connect API,不能用于其他 Apple 服务。

如需使用 App Store Connect API,账户持有人必须先在 App Store Connect 中申请 API 的访问权限。

申请 App Store Connect API 访问权限

必要职能:“账户持有人”职能。请参见职能权限

  1. 在“用户和访问”中,点按“集成”。页面打开时选中“App Store Connect API”。

  2. 点按“请求访问权限”。

  3. 勾选复选框表示同意条款,然后点按“提交”。

提交后,申请会送至审核。我们会根据具体情况予以批准。

生成团队 API 密钥

必要职能:“账户持有人”职能或“管理”职能。请参见职能权限

团队密钥可以用于账户中的所有 App。你可以限定团队密钥的职能权限。

  1. 在“用户和访问”中,点按“集成”。页面打开时选中“App Store Connect API”。

  2. 点按“Team Keys(团队密钥)”。

  3. 点按“生成 API 密钥”。如果已有一个或多个有效 API 密钥,可以点按添加按钮(+)生成更多密钥。

  4. 输入密钥名称。名称仅用于参考,不会包含在密钥中。

  5. 在“访问”下方,选择职能权限,即该 API 可以访问和管理的内容。团队 API 密钥适用于账户中的所有 App,因此你无法限制 API 密钥的 App 访问权限。

  6. 点按“生成”。

API 密钥生成后便无法更改名称或职能权限。如需进行更改,请撤销该密钥并生成新的密钥。详细了解如何管理和保护密钥

生成个人 API 密钥

必要职能:“账户持有人”职能、“管理”职能、“App 管理”职能、“客户支持”职能、“开发者”职能或“营销”职能。请参见职能权限

默认情况下,所有 App Store Connect 用户都可以生成和撤销供个人使用的 API 密钥,除非具有“管理”或“账户持有人”职能的用户撤销了其权限。每个用户在同一时间内只能有一个有效的 API 密钥。

  1. 在任意 App Store Connect 页面的右上角点按你的用户名,然后选择“编辑个人资料”。

  2. 在“个人 API 密钥”下方,点按“Generate Key(生成密钥)”。

  3. 如需下载你的个人 API 密钥,请点按“下载”,然后在对话框中点按“下载”。

    【注】API 密钥为私有密钥,只能下载一次。下载密钥后,请将其存储在安全的地方。密钥一旦丢失或泄漏,请立即将其撤销。

  4. 如需撤销个人 API 密钥,请点按“撤销”,然后在对话框中点按“撤销”。密钥一旦被撤销,将无法恢复。

管理个人和团队密钥

必要职能:“账户持有人”职能或“管理”职能。请参见职能权限

具有“管理”或“账户持有人”职能的用户可以查看和管理团队密钥以及由 App Store Connect 团队成员创建的个人密钥。如果不希望某位成员继续通过 API 密钥来使用 App Store Connect 服务,可以撤销该成员的密钥。如需撤销 API 密钥并防止用户创建新密钥,可以从用户权限中移除“生成个人 API 密钥”。

  1. 在“用户和访问”中,点按“集成”。页面打开时选中“App Store Connect API”。

  2. 在左上方,点按“Individual Keys(个人密钥)”或“Team Keys(团队密钥)”。

  3. 在右上方,点按“编辑”。

  4. 选择要撤销的 API 密钥。

  5. 在右上方点按“撤销密钥”,然后在对话框中点按“撤销”。密钥一旦被撤销,便无法恢复。在“App Store Connect API”页面的“已撤销”列表中,你可以看到过去 30 天内撤销的所有密钥。