App Store Connect: listing, reviews and sales

Connecting App Store Connect lets Appwin read your app's data on the App Store: metadata, reviews, sales.

In everyday use it is read access. The permission level you grant stays your choice, and the key carries as many rights as the role you give it - hence the recommendation below.


1. Create an API key

In App Store Connect: Users and Access → Integrations → API Keys → +

  • give it an explicit name ("Appwin")
  • choose a role

Which role

RoleWhat it allowsRecommendation
DeveloperRead metadata and reviewsEnough for ASO
FinanceRead sales reportsNeeded for revenue
App ManagerEdit listingsOnly if you want to publish from Appwin
AdminEverythingAvoid

The principle: grant the minimum role for what you intend to use. You can create several keys with different roles, and revoke one without touching the others.

Download the .p8.

The .p8 downloads only once. Apple does not regenerate it.


2. Collect the identifiers

FieldWhere to find it
Issuer IDAt the top of the API Keys page, above the table
Key IDA column of the table, or the file name AuthKey_XXXXXXXXXX.p8
Private keyThe contents of the .p8, headers included

The Issuer ID is the same for every key on your account; the Key ID is specific to each key.


3. Identify your app

FieldWhere to find itExample
App IDIn your App Store Connect listing URL, or "Apple ID" in App Information1234567890
Bundle IDApp Informationcom.yourstudio.yourapp
Vendor NumberPayments and Financial Reports, top left87654321

The Vendor Number is only needed for sales reports. Without it, metadata and reviews still work.

Do not confuse the App Store App ID (numeric, Apple's) with the Appwin App ID (the SDK's). Two different notions sharing a name.


4. Enter them in Appwin

App settings → integrations → App Store:

FieldValue
App ID1234567890
Bundle IDcom.yourstudio.yourapp
Issuer IDaaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
Key IDXXXXXXXXXX
Private keyThe contents of the .p8
Vendor Number87654321 (for sales)

What it unlocks

DataMinimum role
Metadata, screenshots, keywordsDeveloper
Reviews and ratingsDeveloper
Sales and revenue reportsFinance

Security

Integration keys are encrypted at rest in the database. They are never sent back in clear to the dashboard: once saved, a key is shown masked and can only be replaced.

If you suspect a leak, revoke the key from App Store Connect - revocation is immediate on Apple's side, independently of what is stored at Appwin.


Troubleshooting

SymptomLikely cause
"Authentication failed"Wrong Issuer ID or Key ID
"Invalid private key"Truncated .p8: the BEGIN/END lines must be included
Empty reviewsYour app has no reviews yet on the markets queried
Empty salesMissing Vendor Number, or a role without Finance permission
403 errorThe key's role does not cover the data requested

Next