借助 App Store Connect API 实现开发流程自动化

欢迎大家 我叫 Dajinsol Jeon 是 App Store Connect 团队的工程师 今天 我将为大家介绍有关 App Store Connect API 的更新 现在开始吧

App Store Connect 提供了 许多 API 来自动化开发流程 让你的团队能专注于最重要的事 为用户打造出色的新功能 今年 App Store Connect 在 App 管理和 TestFlight 等 关键领域大幅扩展了 API 功能 并新增了多组新的 API 包括开发者期待已久的 Webhooks API 和 Apple 托管的 Background Assets API 今天我将重点介绍 Webhooks、BuildUpload 和 Feedback API 等重要 且备受期待的更新内容 但请允许我先简要回顾 典型的 App 开发流程 App 开发是一个循环迭代的过程 你从新功能开发或问题修复开始 将新构建版本上传至 App Store Connect 当新版本完成分发后 Beta 版测试用户会提交反馈 而这些反馈又将 驱动下一轮开发 关键在于你需要 尽可能加速这个循环 例如当用户报告崩溃问题时 快速修复才能带来最佳用户体验 这正是今天要讲的更新的意义所在 全新的 App Store Connect API 能让你自动化整个迭代闭环 大幅提升迭代效率 现在让我们深入解析实现原理 今年 App Store Connect 推出了 Build Upload API 和 Feedback API 以提供更完善的自动化支持 此外 现在 App Store Connect 还支持 Webhook 通知功能 当 App 出现问题时 系统会收到通知 并对这些事件做出响应 例如 当上传的构建版本完成处理时 App Store Connect 会向 你的 Web 挂钩侦听器 发送构建上传状态事件 提示你可以继续执行后续操作 Web 挂钩通知还支持更多事件类型 例如反馈事件 和构建 Beta 版状态事件 让你了解 App 的重要动态 这些新增功能将帮助你 前所未有地大幅缩短开发周期 现在 让我们深入探讨这些增强功能 首先从 Web 挂钩通知开始 传统 API 的工作方式 就像不断打电话询问： “有什么新消息吗？” 你的系统需要持续向 App Store Connect 询问更新 但 Web 挂钩彻底改变了这种模式 它本质上是服务器之间的 推送通信机制 不同于让你的系统持续轮询 App Store Connect 会直接 向你推送事件通知 从技术层面来说 Web 挂钩是 App Store Connect 在 App 关联的 特定事件触发时 向你服务器发起的 HTTP 回调

这让你可以构建事件驱动型工作流 相比持续轮询 App Store Connect 获取更新 效率要高得多 那么它是如何运作的呢？

假设你已搭建了一个 HTTP 服务器 作为 Web 挂钩侦听器 首先需要向 App Store Connect 提供 Web 挂钩侦听器的 URL 本质上就是告知 App Store Connect 推送更新的目标地址 每当 App Store Connect 内 发生相关变更时 系统会向你注册的 URL 发送一个 POST 请求 这个请求的负载包含了 事件的具体信息 基于这些信息 你的系统可以进一步 查询 App Store Connect API 获取更多细节或执行必要的操作 今年 App Store Connect 将针对这些重要事件 推出 Web 挂钩通知功能： 新增的 TestFlight 反馈提交 App 版本状态变更 构建上传状态更改 构建 Beta 版状态变更以及 Apple 托管的 Background Asset 状态变更 要接收这些来自 App Store Connect 的通知 需要先注册 Web 挂钩侦听器 下面我将为你演示如何在 App Store Connect 网站上 注册 Web 挂钩侦听器 首先 导航到“用户和访问”版块 然后选择“集成” 在“集成”页面的侧边栏 找到“Web 挂钩”部分 点按加号按钮 系统将弹出 Web 挂钩配置面板 首先 为 Web 挂钩输入 一个描述性名称 然后 输入 Web 挂钩侦听器的 URL 此处是 App Store Connect 发送通知的 目标端点 现在请注意密钥字段 这非常重要 App Store Connect 会使用这个密钥 对每条 Web 挂钩通知进行签名 你可以使用任意字符串作为密钥 但必须确保只有 App Store Connect 和你自己知道它 这个签名能让你的系统验证 通知确实来自 Apple

最后 你需要选择要订阅的事件 在今天的讲座中 我将启用构建上传 构建 Beta 版状态 和 TestFlight 反馈这三个事件 点按“创建” 即可完成 现在 当你的 App 触发这些事件时 服务器就会收到 对应的 Web 挂钩通知 你也可以通过 API 来设置 Web 挂钩 如果你需要管理大量 App 或者希望为新 App 自动注册 Web 挂钩侦听器 这种方式会特别高效 我来演示如何通过 API 注册 Web 挂钩侦听器 你需要向 Web 挂钩端点 发送一个 POST 请求 这些属性与我们 在 UI 中看到的非常相似 你需要发送想要订阅的事件类型、 App Store Connect 用于 签名事件负载的密钥 以及 Web 挂钩侦听器的 URL 成功创建 Web 挂钩后 你会收到 201 CREATED 响应 负载会包含 Web 挂钩 ID 这个 ID 是后续管理 Web 挂钩的必要标识 这些就是在 App Store Connect 中 注册 Web 挂钩侦听器的流程 以及 Web 挂钩通知的基本原理 我们将使用新版 Build Upload API 实现向 App Store Connect 自动上传新构建的流程 今天要介绍的一个重要升级 就是通过 App Store Connect API 实现构建上传自动化 那 Build Upload API 为何很有用？ 作为标准化 App Store Connect API 的一部分 这个新 Build Upload API 能让构建上传流程 整合到其他自动化环节中 这也意味着你可以使用任意编程语言 或平台进行构建上传 如果你在上传时遇到问题 这些全新 API 会返回 格式规范化的错误信息 便于实现自动化错误处理 这为你提供了一种新的、更灵活的 方法来自动执行构建上传流程 现在我来演示一下具体操作步骤 要使用新 API 上传构建版本 请先创建 BuildUploads BuildUploads 包含版本和 目标平台等构建信息

接着 通过 BuildUploadFiles 向 App Store Connect 提交 构建文件的详细信息 此时 App Store Connect 将提供具体的上传指引

然后按照指引上传构建二进制文件 最后通知 App Store Connect 完成上传 系统随即开始处理新构建版本 现在 我将带你深入了解 这些 API 的技术细节 要创建 BuildUpload 需发起一个 POST 请求 这个请求应包含构建的套装版本 和目标平台 若请求成功 App Store Connect 将返回 201 CREATED 状态 以及这个新 BuildUpload 的唯一 ID 下一步是创建 BuildUploadFile 以便向 App Store Connect 提供文件的具体信息 你需要提交文件名 文件大小的字节数和资源类型 如果 BuildUploadFile 创建成功 你将收到 201 CREATED 响应 在响应正文中 你会看到上传操作的具体指引 其中详细说明了如何上传二进制文件 既提供了构建文件的上传目标 URL 指导你使用 PUT 方法进行传输 还列出了所需的请求头信息 与其他用于文件上传的 App Store Connect API 类似 如果你的构建文件较大 可能会收到 分段上传的指令 这意味着你需要 将二进制文件拆分为多个部分 并发起多个 HTTP 请求进行上传 按照前述响应中的指引 完成上传后 你需要通知 App Store Connect 上传已结束 以触发 App Store Connect 开始处理新构建 只需发送一个 PATCH 请求 并将 uploaded 属性设为 true 即可

若操作成功 你将收到 200 OK 响应 同时状态会显示为 COMPLETE 现在 让我打开 App Store Connect 网站查看新构建版本 网站显示系统已开始处理这个新构建 但这引出了一个关键问题 处理何时完成？ 我们怎么知道呢？ 这正是我们先前配置的 Web 挂钩通知 发挥作用的时候 当处理完成时 它会立即通知你 下面是构建成功处理后 你的服务器将从 App Store Connect 收到的示例通知 关键变化是状态 从 PROCESSING 转变为 COMPLETE 一旦看到 COMPLETE 状态 即可确认构建已处理完毕 可以继续下一步操作 你还会在 X-Apple-SIGNATURE 标头中收到消息签名 这表明 App Store Connect 使用的 是 HMAC-SHA256 加密算法 你可以使用预先配置的密钥 和收到的有效负载体 计算出签名 通过比对计算值与请求头中的值 即可验证通知是否 来自 App Store Connect

这正是通过新 API 实现 构建上传自动化的核心机制 接下来 我将介绍如何 使用 TestFlight 进行 Beta 版测试 当 App Store Connect 完成构建 处理后 你可通过 TestFlight 将新构建版本分发给 Beta 版测试人员 你可直接为 Beta 版 特定测试组分配构建版本 若涉及外部测试者 则需先提交 构建版本进行 Beta 版 App 审核 最后 请记得通知测试人员 新版本已就绪 好消息是 通过 TestFlight API 可实现全流程自动化操作 这些是 App Store Connect 提供的一些 TestFlight API 完整信息详见 App Store Connect API 文档 但请务必牢记关键要点 这些 API 能帮助你 实现测试版本分发的全流程自动化 虽然这些 API 已经非常成熟 但需要特别说明今年新增的 一项实用功能 构建 Beta 版状态 Web 挂钩事件 当 TestFlight Beta 版审核完成时 这个全新的 Web 挂钩 可即时触发通知 以下是构建 Beta 版状态通知的 示例有效负载 其中会显示更新后的状态信息 并包含特定构建 ID 当你收到这个通知时 即表示你的构建版本已通过审核 可以开始外部测试了 好了 这就是使用 TestFlight 分发新构建版本的全流程 接下来 我将介绍如何 收集测试人员的 TestFlight 反馈 反馈是 TestFlight 使用过程中的 关键环节 测试人员可以提交截图反馈 来提出建议或报告 UI 问题 当 App 发生崩溃时还能 提交崩溃反馈 TestFlight 反馈能帮助你 获取推动 App 发展的洞察 及时响应反馈对 提升用户体验至关重要 因此实时获知新反馈尤为重要 此外 由于你肯定不希望 错过测试员的任何反馈 因此 使用开发工具 追踪反馈会非常有用 为此 App Store Connect 全新 推出了 Feedback API 及配套的 Web 挂钩事件 这一众多开发者 期待已久的功能终于实现 我来详细说明一下 当有新的截图反馈时 你会收到一个包含类似 以下内容负载的 Web 挂钩通知 Web 挂钩通知仅包含基础信息 它具有反馈类型 在本例中为屏幕截图 并关联一个相关实例 这个实例显示这是 Beta 版反馈的截图提交内容 同时提供了 ID 标识 你可通过这个 ID 查询这个反馈的详细信息 当调用 Feedback API 获取截图反馈时 返回的响应将包含设备信息、 截图 URL 等各类详情 你可以通过这些 URL 发起独立请求 下载截图文件

获取崩溃反馈的流程 与截图反馈完全相同 但当崩溃日志可用时 你可以通过调用 crashLog 端点 以编程方式下载日志 这就是通过 API 获取 TestFlight 反馈的方法 这就是我们使用 App Store Connect API 完成这个 App 开发过程的方式 通过 WebHook API 及事件获取通知 Build Upload API 提交新版程序 Feedback API 获取测试评价 但远不止于此 例如 如果你使用 Apple 托管的 Background Assets 还可调用新增 API 实现资源管理自动化 App Store Connect 将发送 App 版本状态的 Web 挂钩事件 实时通知你 App 在 App Store 中的状态变化 从而完整覆盖从开发、测试 到最终上架的整个流程 此外 App Store Connect 还提供了众多现有 API 来自动化开发流程的各个阶段 再次强调 自动化日常任务至关重要 因为这能让你更专注于提升用户体验 作为本次讲座的总结 这里有一些建议 首先 构建 Web 挂钩侦听器 以便接收 来自 App Store Connect 的 Web 挂钩通知 其次 基于 Web 挂钩事件 实现响应式行为 从而自动化你的流程 最后 探索 App Store Connect API 的其他功能 并在自动化中利用这些 API 以进一步加快开发周期

另外 别忘了查看“探索 Apple 托管的 Background Assets” 及“App Store Connect 的新功能” 讲座 以获取有关本年度 App Store Connect 更新的更多信息 今天的内容讲完了 希望这次讲座对你有所帮助 感谢观看