An App Store Connect API key lets a tool work with your Apple Developer account without your password: registering devices, creating certificates and profiles, and more. BuildFerry uses one to register the iPhones you approve and sign builds for them.
Before you start
Only the Account Holder can request API access for a team, the first time. After that, Admins can create keys.
Create the key
- Sign in to App Store Connect and open Users and Access.
- Open the Integrations tab and choose App Store Connect API.
- On the Team Keys tab, click Generate API Key, or the add button if you already have keys.
- Name it after the tool that will use it, for example "BuildFerry".
- Choose the access. BuildFerry asks for Admin, because registering devices and creating distribution certificates and profiles need it.
- Click Generate.
Download the key and note its IDs
- Download API Key saves a file named like
AuthKey_ABC123DEFG.p8. Apple lets you download it only once, so keep it safe. - Key ID is the 10 characters in the file name and the Key ID column.
- Issuer ID is shown above the keys table.
In BuildFerry, add the .p8 file and paste the Issuer ID. The Key ID is read from the file name.
Keep it safe
- Never commit the .p8 to a repository or paste it in chat.
- Use one key per tool, so you can revoke one without breaking the others.
- If a key leaks, click Revoke next to it in App Store Connect. It stops working at once.
How BuildFerry stores your key.
Questions
Where do I find my App Store Connect Issuer ID?
In App Store Connect, under Users and Access, Integrations, App Store Connect API. It is shown above the table of team keys.
Can I download an App Store Connect API key again?
No. Apple lets you download the .p8 file only once. If you lose it, revoke the key and create a new one.
Why does the API key need Admin access?
Registering devices and creating distribution certificates and provisioning profiles through the API needs Admin access.