Connecting to Apple services with API key

Japanese translation unavailable

This page has not been translated into Japanese yet - we apologise for the inconvenience! If you’re interested in helping us out, feel free to translate any article in the jp folder of the DevCenter repository and open a PR!

このページは日本語への翻訳がまだ完了しておりません。ご不便をおかけして申し訳ございません! もしお手伝いできる方がいらっしゃれば、ご自由にjpフォルダの記事を日本語に訳していただき、PRを開いてください

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.

Please note that the API key authentication is the recommended way when connecting Bitrise to Apple Services. Please note that you can have 50 API key added to the Apple Services connection page but your project can use only one (selected in the Team tab).

Adding API key authentication data on Bitrise

  1. On App Store Connect, generate a new API key with Admin access under Users and Access.
  2. Log in to
  3. Click on your profile in the upper-right corner of your Dashboard and select Profile settings from the dropdown menu.
  4. On the menu bar select Apple Service Connection.
  5. Click Add connection.
  6. 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 Connect and Upload a Private Key (.p8) buttons won’t be available.
  7. Click Connect.
  8. Continue with assigning an Apple Developer Account for your app.

Assigning API key authentication to your app

When you wish to use a Step with the established connection, you also have to select an app for the connection. This way your app can receive data from your Apple Developer account when your build runs on Bitrise.

  1. Open your app’s page on
  2. Select the Team tab.
  3. Scroll down to the Apple Service connection section.
  4. Select the API key authentication (recommended) method for the app to use in the dropdown.

The Step is now able to connect to the App Store Connect or the Apple Developer Portal during your build.

No Step input modification needed

Please note that there is NO NEED TO MODIFY ANY STEP INPUT fields manually since these are automatically populated once the connection is set up.

What’s next?

Check out Steps that use the official API key authentication.