Topic: apple apiKey

Description

Commands in the apple apiKey topic are prefixed shipthis apple apiKey. These commands relate to App Store Connect API Keys.

• You can view the App Store Connect API Keys in the Apple Developer Portal.
• You can view the keys which ShipThis can use in the ShipThis Dashboard.

info

An App Store Connect API key is used to authenticate and authorize automated interactions with Apple's App Store Connect API, enabling tasks like managing app metadata, TestFlight, and sales reports.

ShipThis uses one of these keys to automatically upload new builds of your games.

tip

You will need to be authenticated against ShipThis and Apple before you can use these commands. To do that please run the following commands first:

• shipthis login
• shipthis apple login

Example

Commands

apple apiKey create

Description

Creates an App Store Connect API Key in your Apple Developer account. Saves the private key in your ShipThis account.

Help Output

apple apiKey export

Description

Saves the current App Store Connect API Key to a ZIP file

Help Output

apple apiKey import

Description

Imports an App Store Connect API Key ZIP file into your ShipThis account

Help Output

apple apiKey status

Description

Displays the status of App Store Connect API Keys in your Apple and ShipThis accounts. This API key is used to automatically publish your games to the App Store.

Help Output