Connecting to an Apple service with API key
Connect to an Apple service with API key to manage iOS code signing and deployment. The API key authentication is the recommended way when connecting Bitrise to Apple Services.
Connecting to an Apple service (such as the App Store Connect or the Apple Developer Portal) with the API key requires that you first add your Apple service authentication data on our Apple Services Connection page, then an API key for your app.
The API key authentication is the recommended way when connecting Bitrise to Apple Services. You can have 50 API keys added to the Apple Services connection page but your project can use only one.
No Step input modifications needed
With this method, all Step inputs related to authenticating with an Apple API key are automatically populated once the connection is set up. You don't have to manually modify those Step input fields at all.
Adding API key authentication data on Bitrise
-
On App Store Connect, generate a new API key with Admin access under Users and Access.
Admin access
You must use the Admin role for the new App Store Connect API key! The Step and your build will fail if you set a different role.
-
Log in to bitrise.io.
-
In the upper right corner, open the account selector dropdown menu.
-
Select the option.
This takes you to the Edit your profile page.
-
On the menu bar select Apple Service Connection.
-
Click .
-
Fill out all required fields: provide the Name, Issuer ID, and the Key ID you generated at Step 1, and Upload a Private key (.p8). If one input is missing, the and buttons won’t be available.
-
Click .
-
Continue with assigning an Apple Developer Account for your app.
Assigning API key authentication to your app
To use API key authentication for Apple services for your app, you must:
-
Assigning that API key to your app.
To assign the API key to the app:
Admin access only
Only users with the role of admin on the app's team can access all functions of the App Settings page of an app.
-
Open your app on Bitrise.
-
On the main page of the app, click on the App Settings icon:
.
-
On the left, select Integrations.
-
Scroll down to the Connection to Apple services section.
-
Find the API key authentication (recommended) option.
-
Click .
-
In the pop-up window, select the API key you need from the dropdown menu.
If you don't have an API key set up, you must add one first.
The Step is now able to connect to the App Store Connect or the Apple Developer Portal during your build.