App Store Connect API Key
지금 만들고 있는 앱의 빌드, 배포 자동화 CI / CD 툴로 Bitrise 를 사용하려는데 API key authentication 을 연결해야 했다. 그래서 먼저 공식문서에서 API Key 에 대한 내용을 공부하게 됐다.
Apple 공식 문서 : https://developer.apple.com/documentation/appstoreconnectapi/creating_api_keys_for_app_store_connect_api
공식문서 정리 - 키 생성 방법
Overview
The App Store Connect API requires a JSON Web Token (JWT) to authorize each request you make to the API. You generate JWTs using an API key downloaded from App Store Connect.
- App Store Connect API 를 사용하려면 JSON Web Token(JWT)이 필요.
- App Store Connect에서 다운로드한 API 키를 사용하여 JWT를 생성한다.
An API key has two parts: a public portion that Apple keeps, and a private key that you download. The private key enables you to sign tokens that authorize access to your data in App Store Connect and the Apple Developer website.
- API 키는 Apple이 보관하는 공개 키와 다운로드한 개인 키의 두 부분으로 구성된다.
- 개인 키를 사용하면 App Store Connect 및 Apple Developer 웹 사이트의 데이터에 액세스할 수 있는 토큰에 서명할 수 있게 된다.
Generate a Private Key and Assign It a Role
- When you create an API key, assign it a role that determines the key's access to areas of the App Store Connect API and permissions for performing tasks. For example, keys with the Admin role have broad permissions and can do things like create new users and delete users.
- API 키를 생성할 때 App Store Connect API 영역에 대한 키의 액세스 권한 및 작업 수행 권한을 결정하는 역할을 할당합니다.
- 예를 들어 관리자 역할의 키는 광범위한 사용 권한을 가지며 새 사용자 생성 및 사용자 삭제와 같은 작업을 수행할 수 있다.
- To generate keys, you must have an Admin account in App Store Connect. You may generate multiple API keys with any roles you choose.
- 키를 생성하려면 앱 스토어 커넥트에 관리자 계정이 있어야 한다. 어떤 역할을 부여하던지 여러 API 키를 생성할 수 있다.
App Store Connect 에서 Key 발급
App Store Connect : https://appstoreconnect.apple.com
- Select Users and Access, and then select the API Keys tab.
- Click Generate API Key or the Add (+) button.
- Enter a name for the key. The name is for your reference only and is not part of the key itself.
- Under Access, select the role for the key.
- Click Generate.
새로운 App Store Connect API Key 가 발급됐다.
Download and Store the Private Key
- Once you've generated your API key, you are given the opportunity to download the private half of the key. The private key is available for download a single time.
- API 키를 생성했으면 키의 개인 절반을 다운로드할 수 있게 된다.
- 개인 키는 한 번만 다운로드 할 수 있다.
- Log in to App Store Connect.
- Select Users and Access, and then select the API Keys tab.
- Click "Download API Key" link next to the new API key.
이제 이 다운로드 받은 API Key (.p8) 를, Bitrise 의 API key authentication 에 업로드 하면 된다.
