How to create an App Store Connect API key for Vimeo OTT Apple applications

This feature requires an Enterprise plan on Vimeo OTT. 

To generate your Apple (iOS and/or tvOS) application builds, our Branded Apps team will require you to create and associate an Apple API key with your Vimeo OTT CMS (i.e. "Admin"). This article is a comprehensive guide for creating the Apple API key and adding it to your Vimeo OTT account. 

⚠️Note: All steps below can only be completed by the Apple Developer Account Account Holder.

Associate an iPhone to your Apple developer account

To have your Apple API key validated, you need to associate an iPhone's unique device identifier (UDID) with your developer account. A UDID is a 40-character-long value containing alpha-numeric symbols (A-Z and 0-9) specific to your device. Apple uses this as a validation step when setting up an application.

To complete this task:

1. Go to your Apple developer interface. After logging in, you should be brought to a page showing Devices.
   
2. Select the BLUE (+) sign next to Devices to be brought to the "Register a New Device" page.
   
3. On this page:
   • Platform = iOS
   • Device Name = Whatever you'd like this value to be. Traditionally, putting the model works best (ex: iPhone 16 Pro)
   • Device ID (UDID) = To retrieve your device's UDID, we recommend using udid.tech. There are also alternative methods available. When you have this information, paste it into this field.
4. Select Continue.
5. Select Register.

Create Your Apple API Key

To complete this task:

1. Go to your Apple App Store Connect account (this is different from the Apple developer account linked in the instructions above) and log in.
2. Depending on whether your developer account is new or not, you may see an option to select Request Access. Once permission is granted, you can create your API key.
   • If you do not see this continue to the next step.
3. Navigate to App Store Connect API, then select the Integrations tab. In here, the Team Keys tab should be selected.
4. Select the BLUE plus (+) icon to create a new API Key
   
5. A "Generate API Key" window should appear. Input the following:
   • Name = OTT App
   • Access = Admin
6. Select Generate.
   
7. Select the Download API Key option, which should appear to the right of your newly created key. Save this file to your computer. It will appear as a .p8 file.
   • ⚠️Note: There may be instances where the Download API Key option does not appear right away. You may need to wait a few minutes, then refresh the page for the option to appear
     

Add your Apple API Key to your Vimeo OTT Admin

To complete this task:

1. Open a new tab in your browser and navigate to your OTT CMS "Store Credentials" page (your_site_name.vhx.tv/admin/manage/settings/store_credentials).
2. Scroll down to the Add or update a credential section.
3. Under Platform select Apple and for Credential type select App Store Connect API key
   
4. Upload your API Key file:
   • Select Choose file and select the .p8 file you've recently downloaded
5. Issuer ID. Within the App Store Connect "Keys" page, you can find this value towards the top of the page. Paste this ID into the Issuer ID field.
   
6. Key ID. Within the App Store Connect "Keys" page, where you created your key, select Copy Key ID. Paste that ID into the Key ID field in your Vimeo OTT CMS.
   
7. Once all three pieces have been copied into their respective fields, select Save credential.
   • If your key was created properly, your information will be saved within this section and be validated.
   • If your key was created improperly, or if you did not associate a device properly, your information will NOT save within this section and you will receive an email within an hour asking you to try again.