One Dev Shop / App Store Connect API key

How to create an App Store Connect API key

Tools that read your App Store numbers, Metrics included, need three things: an issuer ID, a key ID and a private key file. Here is where each comes from.

Generate a team key

You need an Admin account in App Store Connect.

1. Log in to App Store Connect and select Users and Access, then the Integrations tab.
2. Select App Store Connect API in the left column.
3. Make sure the Team Keys tab is selected.
4. Click Generate API Key, or the add button if you already have keys.
5. Enter a name. It is for your reference only.
6. Under Access, select the role for the key. Give it the least access the tool needs.
7. Click Generate.

Find the issuer ID and key ID

Both are on the same Integrations page. The issuer ID appears near the top, with a Copy button. The key ID is in the column next to each active key. Hover beside it to copy.

Download the private key, once

Click Download API Key next to the new key. The private key can be downloaded a single time, and Apple does not keep a copy. Store the file somewhere safe.

If a key is lost or you suspect it is compromised, revoke it in App Store Connect straight away and generate a new one.

Individual keys

A user with the Generate Individual API Keys permission can create a personal key from their user profile, under Individual API Key. Individual keys do not use an issuer ID.

What Metrics does with it

Metrics stores the credentials in the iOS Keychain and talks to App Store Connect directly from your device. Reports are cached on the device. To look around first, choose the demo data option, which needs no key.

Steps follow Apple's documentation: Creating API keys for App Store Connect API and Generating tokens for API requests.