How to create an App Store Connect API key
Vitrine needs an API key to upload your screenshots and follow the state of your versions. You create the key once, and it works for every app on the same developer account.
Before you start
The first API key of an account must be activated by the Account Holder. After that, an administrator can create more keys. If you are neither, ask the Account Holder to follow steps 1 to 3 first.
Create the key
Open Users and Access
In App Store Connect, open Users and Access, then the Integrations tab.
Choose App Store Connect API
In the left column, choose App Store Connect API, then the Team Keys tab.
Request access (first time only)
If your account has never used the API, click Request Access, accept the terms, then wait for activation. The Account Holder must do this.
Generate a key
Click Generate API Key (or the + button).
Give it a clear name
Use a name you will recognize later, for example “Vitrine”.
Choose the App Manager access
App Manager is enough to upload screenshots, manage custom product pages and submit for review. Do not use Admin unless you need it.
Click Generate
The new key appears in the list.
Download the API key
On the new key’s row, click Download API Key. You get a file named AuthKey_XXXXXXXXXX.p8.
One-time download. You can download this file only once. Store it somewhere safe, outside any publicly synced folder and outside any git repository.
Note the Key ID and the Issuer ID
The Key ID is in the Key ID column. The Issuer ID is shown above the table of keys.
Go back to Vitrine
Enter the Issuer ID, the Key ID and the .p8 file, then click Test connection.
Security
The key gives access to your apps without a password. Do not share it and do not send it by e-mail. If it may have been exposed, revoke it on the same page (Revoke Key) and create a new one.
- Keep the
.p8file out of git repositories, shared drives and chat tools. - Use one key per tool, so you can revoke one without breaking the others.
- Pick the lowest access level that does the job.
In Vitrine, your key is encrypted on our servers, never sent back to your browser, and never included in a project export or in logs. Every use is recorded with who, when and which operation. Only workspace owners and admins can add, replace or delete a key.
Common questions
Who can create an App Store Connect API key?
The first key of an account must be activated by the Account Holder. After that, an administrator can create more.
Which access level should the key have?
App Manager is enough to upload screenshots, manage custom product pages and submit a version for review. Avoid Admin unless a tool really needs it.
Can I download the .p8 file again?
No. Apple lets you download it once. If you lose it, revoke the key and generate a new one.
What if my key may have been exposed?
Revoke it in the same App Store Connect page and create a new one.
Next: localize your App Store screenshots or check the accepted screenshot sizes.