How to set up the App Store Connect API

The App Store Connect API enables secure, programmatic automation of tasks in App Store Connect, covering publishing, app metadata, analytics, build uploads, and more. This API is especially valuable for streamlining iOS workflows via BuildFire’s iOS pipeline.

• You must be the Account Holder of your Apple Developer account to set up the App Store Connect API.

1. Log in to App Store Connect with the Account Holder Apple ID.

a. Navigate to Users and Access → Integrations.

b. Select App Store Connect API.

c. Click Request Access, agree to the terms, and confirm.

2. Generate API Key(s)

A- Team API Keys (recommended for full access):

a. In Users and Access → Integrations → Team Keys, click Generate API Key (“+” icon).

b. Name the key for your reference.

c. Choose the Admin access level.

d. Download the .p8 key file immediately—Apple only allows one download.

e. Record:

- Key ID (next to the key)

- Issuer ID

- Team ID (from your Apple Developer account).

B- Individual API Keys (if available to you):

1. Go to your user profile settings.

2. Under Individual API Key, click Generate Key.

3. Download the .p8 file (one-time download).

4. Record the Key ID and Issuer ID.

3. Secure & Store Credentials

a. Keep the .p8 file safe—if lost, you must revoke and generate a new one.

b. Carefully track your Key ID, Issuer ID, and Team ID.

c. Key revocation is permanent and irreversible.

4. Use the API to Automate Your Publishing Workflow

a. Automate build uploads, metadata updates, and TestFlight distributions.

b. Utilize new capabilities such as Webhooks API (for event-driven automation) and Feedback API (for fetching TestFlight reviews and crash logs).

- Example workflow:

1. Upload a build via API.

2. Listen for build completion via webhook.

3. Distribute the build through TestFlight.

4. Retrieve feedback or crash data automatically.

(Optional) Fastlane Integration

- Use API key-based authentication (app_store_connect_api_key) to avoid manual 2FA.

- Automate tasks like build uploads and TestFlight releases with Fastlane’s suite of tools.

• Missing API access or Integrations menu: Only visible to Account Holders.

• Lost .p8 file: You'll need to revoke and generate a new key—Apple doesn’t allow redownload.

• Credential mismatch errors: Check that the Issuer ID, Key ID, and Team ID are precisely correct and match the .p8 file you uploaded.