How to Create an App Store Connect API Key

Yusuf Yılmaz · November 16, 2026 · 8 min read

Short answer

The Account Holder requests API access once. After that, an Admin creates a team key in Users and Access → Integrations → App Store Connect API → Team Keys, picks a role, and downloads the private key (.p8), which can only be downloaded once. A tool then needs three things: the Issuer ID shown at the top of that page, the key's Key ID, and the .p8 file. Pick the narrowest role that does the job: reading analytics reports works with Sales and Reports or Finance, but creating a new analytics report request needs Admin.

What the App Store Connect API is

The App Store Connect API is a REST API that automates what you would otherwise do by hand in App Store Connect and on the Apple Developer website. It covers TestFlight, In-App Purchases and subscriptions, provisioning, app metadata, users and access, customer reviews, and reporting, including sales and financial reports.

Every call is authorized with a JSON Web Token (JWT) that you sign with an API key from your App Store Connect account. These keys only work with this API, not with other Apple services. Apple also warns that changes made through the API affect your real production data, so treat a key with write permissions as seriously as your own login.

Team keys vs individual keys

There are two kinds of keys:

  • Team keys have access to all apps in your account, with permissions set by the role you choose. You can't limit a team key to one app.
  • Individual keys carry the access and roles of the user who created them. Each user can have one active individual key. Individual keys can't use the Provisioning endpoints, Sales and Finance, or notarytool.

For an analytics or reporting tool, that last limit decides it: if the tool reads daily sales reports, it needs a team key. Individual keys also don't use an Issuer ID, which is why tools that ask for one expect a team key.

Requesting API access (Account Holder)

Before anyone can create keys, the Account Holder has to request access to the API. This is a one-time step for the whole account:

  1. In App Store Connect, open Users and Access and click Integrations.
  2. Click Request Access.
  3. Agree to the terms and click Submit.

Apple reviews these requests case by case. On a one-person account that is usually you. Once access is granted, the Account Holder or an Admin can generate team keys.

Creating a team API key

You need an Admin account in App Store Connect. Then:

  1. 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.
  5. Enter a name. It is only for your reference, so name the key after the tool and device that will use it, for example "Meyu reporting – iPhone".
  6. Under Access, select the role.
  7. Click Generate.

The new key's name, Key ID and a download link appear on the page. You can't edit a key's name or access level later; to change either, revoke the key and generate a new one. You can generate multiple team keys, so one key per tool is a good habit: revoking one never breaks the others.

Issuer ID
Top of the Integrations page
Key ID
Column under Active
Private key .p8
Downloadable once
Vendor number
Only for sales reports
What a reporting tool usually asks for.

API roles and permissions

A key's role decides which parts of the API it can reach and what it can change. Key roles are the same roles your team members have. Keep in mind that a team key reaches all apps whatever its role, so the role is your only way to limit it. Here is what Apple's documentation says about the roles that matter for reporting:

ROLEWHAT APPLE SAYSANALYTICS REPORT REQUESTSUSE IT WHEN
AdminBroad permissions, for example creating and deleting users.Create and delete requests; list and download reportsA tool has to create a new analytics report request
FinanceCan list and download analytics reports.Can't create or delete requestsA tool only downloads reports that already exist
Sales and ReportsCan list and download analytics reports and access sales reports, but not finance reports. Apple suggests it for keys you share with a third party for analyzing reports.Can't create or delete requestsA third party only reads reports
Other rolesApp Manager, Developer, Marketing and others match the team roles of the same name.Not among the roles Apple lists for analytics reportsAutomation outside reporting; check the documentation of each endpoint you call

Finding the Issuer ID

Select Users and Access, then the Integrations tab. The Issuer ID appears near the top of the page, above the list of keys, with a Copy button next to it. It looks like a long UUID, such as Apple's example 57246542-96fe-1a63-e053-0824d011072a. It goes into the token as the issuer, so a tool needs it together with the Key ID. Individual keys don't use it.

Finding the Key ID

On the same Integrations page, Key IDs appear in a column under the Active heading. Hover next to a Key ID to show the Copy Key ID link, then click it. A Key ID is short, like Apple's example 2X9R4HXF34.

If you have several team keys, Apple's advice is to use the Key ID of the same private key the tool signs with. Tools also create short-lived tokens from these values; for most requests Apple rejects tokens that are valid for more than 20 minutes, so the tool signs new ones as it goes rather than storing a token.

Downloading and storing the private key

Right after you generate the key, a Download API Key link appears next to it. You can download the private key (.p8) a single time; the link disappears once you do, and Apple doesn't keep a copy. If you lose the file, there is nothing to recover: revoke the key and make a new one.

Store it the way you store passwords:

  • Keep it in a password manager or your system keychain, not loose in your Downloads folder.
  • Don't commit it to a code repository, paste it into chat, or ship it inside an app you distribute.
  • Give it only to tools you trust, and know where each keeps it.

If you think a key has leaked, revoke it right away in App Store Connect. A revoked key can't be reinstated, and keys revoked in the past 30 days are listed under Revoked.

Analytics report requests

Analytics data in the API, such as the App Store engagement reports, doesn't come from a simple "get my numbers" call. First, someone creates an analytics report request for the app. Apple then generates reports to fulfill it, and a tool lists those reports, picks instances by granularity and date, and downloads the report files.

There are two access types. An ONGOING request is the usual choice: it keeps generating daily, weekly and monthly reports with current data. A ONE_TIME_SNAPSHOT collects the historical data available on the day you ask and doesn't generate anything new afterwards. If nobody retrieves data for a long time, an ongoing request can change to stoppedDueToInactivity, and a new request is needed to resume.

Why Admin access is needed to create a new analytics report request

Apple's role table for analytics reports is specific. Only the Admin role can manage report requests, meaning create them (POST /v1/analyticsReportRequests) and delete them. Finance and Sales and Reports can list and download the reports a request produces, but can't create one.

So Admin is needed for that one operation, not for everything in the API. A tool that only reads reports from a request that already exists can work with a narrower role, and Apple recommends Sales and Reports when you share a key with a third party. A tool that has to create the request itself, because none exists yet for your app, needs an Admin key. Before you hand one over, check what else the tool does with it and where it keeps it.

AsoGlass is an example of the second kind. The App Store Connect connection is optional; you add the Issuer ID, the .p8 file (the Key ID is filled in from the file name) and your vendor number under Settings → Connections. The vendor number, needed for daily downloads from Sales and Trends, is under Reports at the top left, below your legal entity name (visible to the Account Holder, Admin and Finance roles). AsoGlass only reads data, with one exception: it creates the analytics report request Apple requires before producing impressions data, which is why the key needs the Admin role. The key is stored in the iPhone Keychain and used only for signed requests from your iPhone directly to Apple; there is no AsoGlass server. You then see daily downloads by country, impressions, product page views and the share of downloads from App Store search. The support page has the same setup in four steps, the privacy policy explains where the key is kept, and the FAQ covers the rest.

App Store Connect feature →

Report availability and delays

A new key doesn't bring data instantly. Apple says the first analytics report generates in one to two days after the request, and ongoing reports then arrive daily. Sales reports have their own schedule. The guide to App Store Connect metrics covers what each number means, when each report lands and why a day without a report is not a zero.

If you are connecting your account to judge an upcoming name, subtitle or keyword field change, do it before you ship the change. A couple of weeks of data before the change gives you a baseline, as described in the guide to measuring metadata changes.

FAQ

Do I need the Account Holder every time I create a key?

No. Only the Account Holder can request API access, but that is a one-time step. After that, the Account Holder or an Admin can generate team keys.

Can I change a key's role later?

No. You can't edit a key's name or access level after generating it. Revoke the key and generate a new one with the role you need.

I lost the .p8 file. Can I download it again?

No. The private key can be downloaded only once, and Apple doesn't keep a copy. Revoke the old key and create a new one.

Does every API call need an Admin key?

No. For analytics reports, Admin is needed to create or delete a report request. Listing and downloading reports also works with Finance or Sales and Reports. Other areas of the API have their own role requirements.

Can I use an individual key for sales data?

No. Individual keys can't access Sales and Finance, so a tool that reads daily sales reports needs a team key.

Sources Apple Developer Documentation, “App Store Connect API” Apple Developer Documentation, “Creating API Keys for App Store Connect API” App Store Connect Help, “App Store Connect API” Apple Developer Documentation, “Generating Tokens for API Requests” Apple Developer Documentation, “Downloading Analytics Reports” App Store Connect Help, “View payments and proceeds”
App Store Connect· 10 min read
Understanding App Store Connect Analytics for ASO Understand App Store downloads, impressions, product page views and App Store search acquisition using Apple's official analytics data and report timing.
Measurement· 10 min read
How to Measure ASO Metadata Changes Learn how to evaluate App Store name, subtitle and keyword changes using keyword rankings, historical comparisons and App Store Connect data.
Keyword rankings· 3 min read
How to track App Store keyword rankings What an App Store keyword ranking is, why it differs from country to country, the limits of checking by hand, and how to track your rankings every day.