App Store Connect API로 개발 흐름 자동화하기

안녕하세요 저는 App Store Connect 팀의 엔지니어인 Dajinsol Jeon입니다 오늘은 App Store Connect API의 업데이트를 소개해 드리겠습니다 시작하겠습니다

App Store Connect는 개발 절차를 자동화하는 여러 API를 제공합니다 자동화를 적용하면 개발자는 중요한 일에 집중하고 사용자를 위해 우수한 새 기능을 빌드할 수 있습니다 올해 App Store Connect는 앱 관리, TestFlight와 같은 핵심 분야에서 API를 상당히 확장했습니다 또한 App Store Connect는 많은 기대를 받은 Webhooks API Apple-Hosted Background Assets API와 같은 새 API를 지원합니다 오늘은 Webhooks, BuildUpload Feedback API처럼 중요하면서도 여러분이 오래 기다렸던 업데이트를 다루겠습니다 먼저, 일반적인 앱 개발 절차를 요약하여 설명할게요 앱 개발은 반복적인 과정입니다 개발자가 새 기능이나 버그 수정을 시작하고 새 빌드를 App Store Connect에 업로드합니다 새 빌드가 배포되면 베타 테스터가 피드백을 제출하고 다음 개발 단계에서 개발자가 이전 빌드에 대한 피드백을 반영하게 되죠 핵심은 이러한 절차들을 가능한 한 빨리 완료하는 것입니다 만약 사용자가 충돌을 신고하면 빨리 수정하여 더 나은 사용자 경험을 제공해야 합니다 오늘 다루는 업데이트가 여기서 도움이 되죠 새 App Store Connect API는 이 절차들을 자동화하여 훨씬 빠른 반복을 가능하게 합니다 자세히 살펴볼게요 올해 App Store Connect는 더 나은 자동화를 지원하기 위해 Build Upload API와 Feedback API를 도입합니다 또한 App Store Connect는 이제 웹훅 알림을 지원합니다 앱에서 무언가 발생하고 이벤트에 대해 반응할 때 시스템에서 알림을 받을 수 있죠 예로, 업로드된 빌드의 처리가 끝나면 App Store Connect가 웹훅 리스너로 빌드 업로드 상태 이벤트를 전송합니다 다음 단계를 진행할 수 있다는 신호입니다 웹훅 알림은 피드백 이벤트나 빌드 베타 상태 이벤트처럼 앱에 관한 중요한 이벤트를 알려 주는 다른 이벤트도 지원합니다 추가되는 기능으로 개발 절차의 속도를 높일 수 있습니다 이제 개선 사항을 자세히 살펴보겠습니다 먼저 웹훅 알림을 설명하겠습니다 기존 API는 “새로운 소식이 있나요?”라고 계속 전화를 걸어 묻는 것과 같은 방식으로 작동합니다 시스템이 App Store Connect에 업데이트를 계속 요청해야 하죠 그러나 웹훅은 이와 다릅니다 웹훅은 본질적으로 서버 간 푸시 커뮤니케이션입니다 시스템에서 계속 묻는 대신 App Store Connect가 이벤트에 대한 알림을 전송합니다 기술적으로 말하면 앱과 관련된 특정 이벤트가 발생할 때 App Store Connect에서 서버로 HTTP 콜백을 전송하게 됩니다

이 기능으로 App Store Connect를 지속적으로 폴링하는 것보다 훨씬 효율적인 이벤트 기반 작업 흐름을 빌드할 수 있습니다 그렇다면 이 기능은 어떻게 작동할까요?

웹훅 리스너인 HTTP 서버가 있다고 가정하겠습니다 먼저 App Store Connect에 웹훅 리스너의 URL을 제공하여 업데이트를 전송할 위치를 알려 줍니다 그 후 App Store Connect 내에서 관련 변경 사항이 발생하면 해당 URL로 POST 요청을 전송합니다 요청 페이로드에는 이벤트에 관한 정보가 포함됩니다 이 페이로드를 기반으로 시스템은 App Store Connect API에 쿼리하여 추가 정보를 받거나 필요한 작업을 실행할 수 있죠 올해 App Store Connect는 중요한 이벤트에 대한 웹훅 알림을 도입합니다 새 TestFlight 피드백 제출 앱 버전 상태 변경 빌드 업로드 상태 변경 빌드 베타 상태 변경, Apple-Hosted Background Asset 상태 변경 이벤트죠 이 알림을 App Store Connect에서 수신하려면 먼저 웹훅 리스너를 등록해야 합니다 App Store Connect 웹사이트에서 웹훅 리스너를 등록하는 방법을 보여드릴게요 먼저 Users and Access 섹션으로 이동합니다 그다음 Integrations를 선택합니다 Integrations 내 사이드바에 Webhooks 섹션이 있습니다 더하기 버튼을 클릭합니다 웹훅 세부 정보를 구성할 수 있는 패널이 열립니다 먼저, 웹훅에 기술적인 이름을 지정합니다 그다음, 웹훅 리스너의 URL을 입력합니다 이 URL은 App Store Connect가 알림을 전송하는 엔드포인트가 됩니다 이제 Secret 필드에 주목하세요 매우 중요합니다 App Store Connect는 비밀 키를 사용하여 웹훅 알림에 서명합니다 비밀 키로 어떤 문자열이든 사용할 수 있지만 비밀 키는 App Store Connect와 개발자만 알고 있어야 합니다 이 서명을 통해 시스템은 해당 알림이 실제로 Apple에서 전송되었음을 알게 됩니다

마지막으로 구독할 이벤트를 선택해야 합니다 이 세션에서는 빌드 업로드와 빌드 베타 상태 및 TestFlight 피드백 이벤트를 활성화하겠습니다 Create를 클릭합니다 끝났습니다 이벤트가 앱에서 발생할 때마다 서버가 웹훅 알림을 받게 됩니다 API를 사용하여 웹훅을 설정할 수도 있습니다 이 방법은 여러 앱을 관리하거나 새 앱에 웹훅 리스너를 자동으로 등록하려는 경우 특히 유용합니다 API를 사용하여 웹훅 리스너를 등록하는 방법입니다 API를 사용하여 웹훅 리스너를 등록하려면 웹훅 엔드포인트로 POST 요청을 전송해야 합니다 속성은 UI에서 본 것과 매우 유사합니다 구독할 이벤트 유형과 이벤트 페이로드를 서명할 때 사용될 App Store Connect의 비밀 키, 웹훅 리스너의 URL을 전송해야 합니다 웹훅이 생성되면 201 CREATED 응답을 받게 됩니다 페이로드에는 웹훅 ID가 포함되며 이는 나중에 웹훅을 관리하는 데 필요합니다 웹훅 알림을 설명하고 App Store Connect에 웹훅 리스너를 등록하는 방법을 알려 드렸습니다 이제 새 Build Upload API로 App Store Connect에 새 빌드를 업로드하는 절차를 자동화하겠습니다 이번의 주요 개선 사항 중 하나는 App Store Connect API로 빌드 업로드를 자동화하는 기능입니다 Build Upload API는 왜 유용할까요? 새 Build Upload API는 표준화된 App Store Connect API의 일부로 빌드 업로드를 자동화 절차의 나머지 부분에 통합할 수 있습니다 즉, 여러분이 선호하는 언어나 플랫폼으로 빌드를 업로드할 수 있죠 업로드 시 문제가 발생하면 새 API가 오류 처리를 자동화하는 데 도움이 되는 형식화된 메시지를 제공하죠 새롭고 유연한 방식으로 빌드 업로드 절차를 자동화할 수 있죠 그 방법을 보여드리겠습니다 새 API로 빌드를 업로드하려면 먼저 BuildUploads를 생성합니다 BuildUploads에는 버전, 대상 플랫폼 등 빌드 정보가 포함되죠

다음으로 BuildUploadFiles를 사용하여 App Store Connect에 빌드 파일의 세부 정보를 제공합니다 App Store Connect가 빌드를 업로드하는 방법을 안내합니다

이 안내에 따라 빌드 바이너리를 업로드하세요 마지막으로 업로드가 완료되었음을 App Store Connect에 알리세요 이렇게 하면 새로운 빌드 처리가 시작됩니다 이제 API와 관련된 세부적인 단계를 설명하겠습니다 BuildUpload를 생성하려면 POST 요청을 만드세요 이 요청에는 빌드의 번들 버전과 대상 플랫폼이 포함되어야 합니다 요청이 성공하면 App Store Connect가 새 BuildUpload에 대해 고유 ID와 201 CREATED 상태를 반환합니다 다음으로 App Store Connect에 파일 세부 정보를 알리기 위해 BuildUploadFile을 생성합니다 파일 이름, 바이트 단위의 크기 및 애셋 유형을 포함해야 합니다 BuildUploadFile이 성공적으로 생성되면 201 CREATED 응답을 받게 됩니다 응답 본문에는 업로드 작업이 포함됩니다 이 정보는 바이너리를 업로드하는 방법을 알려 줍니다 빌드를 전송할 URL을 알리고 PUT 메서드를 사용하도록 지시하며 필요한 헤더를 나열해 줍니다 다른 파일 업로드용 App Store Connect API처럼 빌드가 큰 경우 여러 청크로 나누어 업로드하기 위한 여러 안내가 제공될 수 있습니다 이 경우, 바이너리의 다른 부분을 포함하는 여러 HTTP 요청을 만들어야 합니다 이전 응답의 지침에 따라 빌드를 업로드했다면 업로드가 실제로 완료되었음을 App Store Connect에 알려야 합니다 새 빌드 처리를 시작하라고 App Store Connect에 알리게 되죠 이를 위해 uploaded 속성이 true인 PATCH 요청을 전송하세요

완료 시 200 OK 응답과 COMPLETE 상태를 받게 됩니다 App Store Connect 웹사이트에서 새 빌드를 확인해 보죠 새 빌드 처리가 시작되었다고 웹사이트에 표시되어 있습니다 그런데 여기서 중요한 의문이 제기됩니다 처리는 언제 완료될까요? 완료되면 어떻게 알 수 있을까요? 이때 아까 구성한 웹훅 알림이 제 역할을 합니다 이 처리 과정이 완료되는 즉시 알림이 전송됩니다 빌드가 처리되었을 때 서버가 App Store Connect로부터 받는 알림의 예시입니다 주목할 점은 상태가 PROCESSING에서 COMPLETE로 전환됐다는 점입니다 COMPLETE 상태를 통해 빌드가 처리되었으며 다음 단계를 진행해도 된다는 점을 알 수 있습니다 또한 x-apple-signature 헤더에 메시지 서명이 표시됩니다 App Store Connect가 HMAC-SHA256 알고리즘을 사용함을 알 수 있죠 설정한 비밀 키와 수신한 페이로드 본문을 사용하여 서명을 계산한 후 계산된 값과 헤더 값을 비교하여 알림이 App Store Connect에서 전송되었는지 확인할 수 있습니다

새 API로 빌드 업로드 절차를 자동화하는 방법을 다뤘습니다 이제 TestFlight를 사용한 베타 테스트로 넘어가겠습니다 App Store Connect에서 빌드가 처리되면 TestFlight를 통해 새 빌드를 베타 테스터에게 배포할 수 있습니다 빌드를 특정 베타 테스터 그룹에 바로 할당할 수도 있습니다 외부 테스터의 경우 먼저 베타 앱 심사에 빌드를 제출해야 합니다 마지막으로 새 빌드가 있다고 테스터에게 알리는 것이 좋습니다 이제 이 모든 단계를 TestFlight API를 사용하여 자동화할 수 있습니다 App Store Connect에서 제공하는 TestFlight API 중 일부입니다 자세한 정보는 App Store Connect API 문서에서 확인할 수 있습니다 이 API를 사용하여 테스터를 대상으로 한 빌드 배포를 완전히 자동화할 수 있다는 점은 꼭 숙지하세요 이 API들도 유용하지만 올해 새로 추가됐으며 유용한 빌드 베타 상태 웹훅 이벤트를 강조하고 싶습니다 이 새로운 웹훅은 TestFlight 베타 심사가 완료되면 즉시 알림을 전송하도록 설계되었습니다 빌드 베타 상태 알림 페이로드의 예시입니다 페이로드에는 업데이트된 상태와 특정 빌드 ID가 포함됩니다 이 알림을 받으면 빌드가 심사를 통과했으며 외부 테스트가 가능하다는 것을 알 수 있습니다 지금까지 TestFlight로 새 빌드를 배포하는 방법을 알아보았습니다 이제 테스터로부터 TestFlight 피드백을 받는 방법을 설명할게요 피드백은 TestFlight 사용에 있어 큰 비중을 차지합니다 테스터는 기능 제안, UI 문제 신고를 위해 스크린샷 피드백을 제출하거나 앱 충돌이 발생할 때 충돌 피드백을 제출할 수 있습니다 TestFlight 피드백은 앱 개선에 유용한 정보를 제공합니다 피드백에 빠르게 대응해야 더 나은 사용자 경험을 제공할 수 있습니다 따라서 새 피드백이 도착했을 때 즉시 알 수 있는 것이 중요합니다 또한 개발 도구로 피드백을 추적하면 테스터의 피드백을 놓칠 일이 없으므로 매우 유용하죠 이를 위해 App Store Connect는 새로운 Feedback API와 대응하는 웹훅 이벤트를 도입합니다 많은 개발자가 오랫동안 요청해 온 기능입니다 자세한 내용을 살펴보겠습니다 새 스크린샷 피드백을 받으면 이와 유사한 페이로드가 포함된 웹훅 알림을 받게 됩니다 웹훅 알림에는 최소한의 정보가 포함됩니다 피드백 유형이 있습니다 이 경우 스크린샷입니다 또한 관련 인스턴스도 포함합니다 인스턴스는 이 피드백이 베타 피드백 스크린샷 제출임을 알리며 ID도 포함합니다 이 ID를 사용하여 피드백의 세부 정보를 조회할 수 있습니다 Feedback API를 호출하여 스크린샷 피드백을 조회하면 기기 정보와 스크린샷 URL을 비롯한 여러 정보를 포함하는 응답을 받게 됩니다 이 URL을 사용하여 별도의 호출로 스크린샷 이미지를 다운로드할 수 있습니다

충돌 피드백도 스크린샷 피드백과 유사한 방식으로 받을 수 있지만 충돌 로그가 있다면 crashLog 엔드포인트를 호출하여 프로그래밍 방식으로 다운로드할 수 있습니다 API로 TestFlight 피드백을 가져오는 방법을 다뤘습니다 지금까지 App Store Connect API로 앱 개발 절차를 완료하는 방법과 Webhook API 및 알림 수신을 위한 이벤트 새 빌드를 업로드하기 위한 Build Upload API 피드백을 가져오는 Feedback API에 대해 설명했습니다 유용한 API는 더 많습니다 Apple-Hosted Background Asset을 사용한다면 애셋 관리 자동화를 위한 새 API를 활용할 수 있습니다 App Store Connect가 App Store 내 앱 상태 변경을 알리기 위해 앱 버전 상태 웹훅 이벤트를 전송하므로 개발부터 테스트, 최종 출시까지의 절차를 완료할 수 있습니다 App Store Connect는 개발 절차의 여러 단계를 자동화시키는 여러 기존 API도 제공합니다 다시 언급하자면, 일상적인 작업을 자동화하면 더 나은 사용자 경험을 제공하는 데 집중할 수 있으므로 중요합니다 오늘 세션을 마무리하며 몇 가지 작업을 추천할게요 첫째, App Store Connect에서 웹훅 알림을 받기 위해 웹훅 리스너를 빌드하세요 둘째, 웹훅 이벤트에 기반한 반응형 동작을 구현하여 절차를 자동화하세요 마지막으로, App Store Connect API가 제공하는 다른 기능을 살펴보고 활용하여 개발 절차의 속도를 더욱 높이세요

또한 올해 출시된 App Store Connect 버전을 다룬 ‘Apple-Hosted Background Assets 알아보기’와 ‘App Store Connect의 새로운 기능’ 세션도 확인해 보세요 오늘 내용은 여기까지입니다 이 세션이 여러분에게 도움이 되기를 바랍니다 시청해 주셔서 감사합니다