Create and use an App Store Connect API Key

This guide will walk you through the steps to create an App Store Connect API key with a developer role and use it with Abra Desktop. The API key will be used to access the Certificates, Profiles and Devices section of your App Store Connect account. This is needed to resign the app, allowing you to run accessibility tests on physical iOS devices.

Prerequisites

• Admin access to App Store Connect.

Setup your App Store API Key

1. Sign in to App Store Connect

   • Navigate to App Store Connect and sign in.

2. Access the API Keys section

   • From the App Store Connect dashboard, click on Users and Access.

   • Select the Integrations tab.

   • Select the App Store Connect API section in the left-hand side.

   • Click the request permission button if needed. It should be granted immediately by Apple.

3. Create a new API key

   • Click on the "+" button to add a new API key.

   • Enter a name for the API key (e.g., Abra App Resigning Key).

   • Choose the appropriate access role for the API key. A minimum role of Developer is required.

   • Click Generate to create the key.

     

4. Download the API Key

   • Once the API key is generated, you will be presented with a .p8 file. This file contains the private key and can now be downloaded.

   • Save the .p8 file in a secure location, as it will not be available for download again.

     

5. Note the Key ID and Issuer ID

   • The Key ID and Issuer ID are displayed on the screen. Make sure to note these down.

6. Authenticate with your App Store API credentials

   • Open Abra Desktop, open the Settings menu and select the Resign tab.

   • Type in Issuer ID and Key ID and select the .p8 private key file. Press Authenticate to verify the credentials and continue.