App Store Linking

Follow this guide to get your App Store account key for use with Apptonomy.

1. Go to: App Store Connect API

Don’t see the App Store Connect API tab?

Admin Role Required For API Key Creation

If the App Store Connect API tab is not visible, it means the signed-in account does not have admin permission (required).

Upon landing on App Store Connect API page you might need request access to the API before proceeding. This should take a few seconds if required.

2. Make sure the Team Keys tab is selected.
3. Click Generate API Key or the Add (+) button.
4. Enter a name for the key. The name is for your reference only and isn’t part of the key itself.
5. Under Access, select both the App Manager and Sales and Reports roles. These are the minimum permissions required for Apptonomy to manage store listings and track performance for your app(s).

About The Required Roles

App Manager gives Apptonomy the ability to read and write app listing data across all localizations — this is what lets us publish screenshots, titles, subtitles, descriptions, and keywords on your behalf.

Sales and Reports gives Apptonomy access to analytics data so you can track the performance of your ASO across revision cycles and measure the impact of the changes we make.

Read more about roles and permissions in App Store Connect here.

6. Click Generate
7. The new key appears in the Active keys list.
8. Download the .p8 key file.

One-time Download

The key file is only available to download once. Keep it secure and revoke/regenerate it if it becomes lost or compromised.

9. Copy the Key ID and Issuer ID for use with Apptonomy. (Issuer ID is at the top of the page)

10. Find your Vendor Number. Apptonomy needs this to ingest revenue and developer-proceeds data from Apple’s Sales & Trends API.

    1. Go to Payments and Financial Reports in App Store Connect.
    2. Your Vendor Number appears near the top of the page — a 6-10 digit numeric value.
    3. Copy it and paste it into the Vendor Number field when linking your App Store account in Apptonomy.

Why Apptonomy Needs Your Vendor Number

Apple’s Sales & Trends API requires this identifier on every request to disambiguate accounts that may have access to multiple vendor IDs. Without it, your App Store will link successfully but you won’t see revenue or proceeds data in your Apptonomy dashboards.

That’s it! Now return to Apptonomy and click the Connect App Store button and enter the Key ID, Issuer ID, Vendor Number, and upload the p8 file.

Key File Security

The p8 file contains a key that can be used to access your App Store Connect account and make changes (e.g. submit screenshots and app store descriptions, etc). Apptonomy treats the p8 key as highly sensitive information. The file is encrypted in the browser before uploading via SSL/TLS then it is re-encrypted and stored according to best practices.

Read about how Apptonomy secures keys

---

See Also

Apple Documentation