Simpplr Branded iOS App Distribution Guide (via Apple Developer account)

Background

At Simpplr, we are committed to providing you with efficient and tailored solutions for distributing your branded iOS apps. We understand that standard distribution methods can come with limitations, such as the inability for end users to search for your app directly on the App Store. To overcome these challenges, we have created the option to distribute your iOS app through your own Apple Developer account.

Challenges associated with standard distribution methods include:

• Limited discoverability for end users on the App Store

• Dependence on Mobile Device Management (MDM) or direct download links

Simpplr has introduced two more options to distribute the branded app via your (the customer’s) own account:

1. We manage the distribution via your account (recommended)

2. We share the IPA file with you to distribute your branded app

Prerequisites

Account creation

Identifier (App ID)

App Group

Configure the App Group for App Target Identifier and Share Extension Identifier

Create an App ID for Share Extension

Create a new app in the App Store

Account creation

Registering for the Apple Developer Program is an essential step in distributing your iOS app through the App Store. Here's a detailed guide on how to register for the program. First, you'll need an Apple ID.

• If you already have an Apple ID, you can use it to sign in to the Apple Developer Program. Skip ahead to Steps to create the app ID.

To obtain an Apple ID:

1. 1. Visit the Apple ID account creation page and follow the instructions to set up your Apple ID. Be sure to provide accurate and up-to-date information.

   2. Check for an Existing Organization Apple ID.

   3. If you are representing an organization, check if your organization already has an Apple ID registered with Apple. It's possible that someone in your organization has already created one for development purposes.

   4. Obtain a D-U-N-S Number. A D-U-N-S (Data Universal Numbering System) number is a unique identifier for your organization, and it's required for enrolling in the Apple Developer Program.

   5. If your organization doesn't have a D-U-N-S number, you can request one for free from Dun & Bradstreet. Visit the D-U-N-S Number registration page on the Apple Developer website and follow the instructions to request a D-U-N-S number.

   6. Make sure to provide accurate information about your organization during this process.

   7. Enroll in the Apple Developer Program.

   8. Once you have your Apple ID and D-U-N-S number, you can enroll in the Apple Developer Program. Visit the Apple Developer Program enrollment page and sign in with your Apple ID.

   9. Follow the enrollment instructions carefully. You'll need to provide details about your organization, contact information, and payment details. The membership fee is $99 per year (pricing may vary by region).

   10. Review the terms and conditions, and if you agree, accept them to complete the enrollment process.

Verification and possible follow-up

After enrolling, Apple may contact you within a few days to verify your enrollment details. They may ask questions to ensure that your app's intentions align with their guidelines. Here are some potential questions Apple might ask:

• • • What is your organization name? This is to confirm that it matches the name used for your D-U-N-S number.

    • What is your department? Provide the department within your organization where you (the contact person) work.

    • What is the purpose of the app? Explain how your app will have public relevance and benefit a widespread audience. You can mention features like job postings, news updates, and employee-specific information.

Identifier (App ID)

Another prerequisite you'll need is a unique Identifier (e.g., com.simpplr.cb.xxxxxx) along with the selection of associated domains, data protection, app group, and push notifications (to be created by your org).

Steps to create the app ID:

1. Sign in to your Apple Developer account and go to Certificates, IDs & Profiles > Identifiers > App IDs.

2. Add a new app ID, providing a name (not visible to end users) and a Bundle ID (e.g., com.simpplr.cb.xxxxxx).
   

   

3. Activate Explicit App ID and select the required services, such as associated domains, data protection, app group, and push notifications.

4. Review the entered data and submit.

App Group

The next prerequisite is an App Group (e.g., group.com.cb-as.xxxxxx) created by your org. The steps to create app group are as follows:

1. Sign in to your Apple Developer account and go to Identifiers.

2. Tap on the + button on Identifier, then select App Groups.
   

3. Enter the App Group name and its identifier (for example, group.com.cb-as.xxxxx) for the branded app.
   

4. Review the entered data and submit.

Configure App Group

Next you'll need to configure the App Group for the App Target Identifier and share the extension Identifier.

1. After creating the app group, move to the respective identifier. Click on that identifier.
   

2. Now click on Configure to select the particular App Group associated with branded app.
   
3. Review the information and submit.

Create an App ID for Share Extension

Follow the same process as for the creation of your App ID, but this time, use the identifier com.simpplr.cb.xxxxx.extension.

Follow the same process to configure the App Group for Share Extension Identifier as well.

Create a new app in the App Store

1. Log in to https://appstoreconnect.apple.com.

2. Tap the + icon beside Apps.
   

3. Tap on New App.
   

4. Fill the required fields (choose the bundle ID you created for this app earlier) and tap on Create.

5. You'll be prompted to enter an SKU number. To get the SKU number, create one from this site Online UUID Generator Tool.

Option 1: We Manage the Distribution via Your Account (Recommended)

To add a user as an admin in your App Store Connect developer account, follow these steps:

1. Go to App Store Connect and sign in with your Apple ID credentials associated with your developer account.

2. Navigate to Users and Access: Once you're logged in, click on Users and Access from the main dashboard.

3. Invite a new user. Under the Users section, click the + (plus) button to invite a new user.

4. Fill in the user details. You'll need to provide the following information for the new user:

   • First Name: Enter the user's first name.

   • Last Name: Enter the user's last name.

   • Email Address: Enter the user's email address. This should be the email associated with their Apple ID or an email they can use to create an Apple ID if they don't have one.

   • Roles: Select the role for the user. To make someone an admin, select the Admin role.

   • Select the app.

5. Configure access. You can choose to give the user access to specific apps or resources if needed. You can configure their access under the Apps section.

6. Click the Invite button to send the invitation to the user.

7. The user will receive an email invitation to join your team on App Store Connect. They will need to accept the invitation and sign in with their Apple ID.

8. Once the user accepts the invitation and signs in, they will have admin access to your App Store Connect account.

That's it! The user is now added as an admin to your App Store Connect developer account and can assist in managing your apps and resources.

Option 2: We (Simpplr) share the IPA file with you to distribute the branded app

Details needed to create an IPA file:

• Generate .p8 file

• Certificate creation

  • iOS distribution certificate

  • Production SSL certificate for push notifications

• iOS provisioning profile creation

  • Provisioning profile of type store

  • Provisioning profile of type ad-hoc

• Creation of app profile in the App Store Connect

• Send app details to Simpplr

  • Share Identifier

  • Share app group id

  • Share extension id

  • Share .p8 file

  • iOS Distribution certificate file that you downloaded and converted to .p12 earlier

  • iOS Production SSL certificate file that you downloaded and converted to .p12 earlier

  • iOS Provisioning profile file of type App Store that you downloaded as .mobileprovision

  • iOS Provisioning profile file of type Ad Hoc that you downloaded as .mobileprovision

• From the app profile in App Store Connect we need the following information:

  • Bundle ID, e.g. com.yourcompany.appname

  • Apple ID, e.g. 1234567890

Create .p8 file

Steps to generate .p8 file

Access App Store Connect:

• Once your enrollment is approved and processed, you can access App Store Connect using your Apple ID. This platform is where you'll manage your app's presence on the App Store.

Before exploring the distribution options, ensure you meet the following prerequisites:

1. Sign in to App Store Connect.

2. Navigate to Users and Access > Keys tab.

3. Select Generate API Key or the + (plus) button.

   • Enter a name for the API key (for your reference only), e.g., "Simpplr API Access."

   • Under Access, select the role Account Holder or Admin for the API key. Click Generate.
     
     

     

4. Download the .p8 file with the private key.

   • Note: The .p8 file with the private key is available for download once. However, as an Account Holder or admin, you can always generate a new .p8 file with a new API key.

5. Store the .p8 file securely.

Create certificates

iOS distribution certificate

If you're responsible for building the app, you'll need access to the necessary signing certificates and provisioning profiles to compile and sign the app correctly.

Creating the iOS Distribution Certificate

The iOS distribution certificate plays a critical role in ensuring that your app's code remains secure and unaltered during the distribution process. Here's a step-by-step guide to create this certificate:

Preparing the iOS distribution certificate

1. Log in to your Apple Developer account and navigate to Certificates, IDs & Profiles > Certificates > Production.

2. Click Add a New Certificate.

3. Choose the certificate type as Production and activate options for App Store and Ad Hoc.
   

4. Click Continue to proceed with the certificate creation.

Generating a Certificate Signing Request (CSR)

To continue the certificate creation process, you'll need a Certificate Signing Request (CSR). Follow these steps to generate one:

Preparing the signing of the certificate

1. You'll need a Mac computer:

   • The following steps require a Mac. If you're using a different operating system, please contact your Customer Success Manager for further assistance.

2. Open Keychain Access:

   • On your Mac, open the Keychain Access program.

3. Request a certificate from a Certificate Authority:

   • In the Keychain Access menu bar, navigate to Keychain Access > Certificate Assistant > Request a Certificate From a Certificate Authority.
     

4. The Certificate Assistant will create a Certificate Signing Request (CSR) that will be submitted to a certificate authority for verification. Enter your Apple ID and email address when prompted.

5. Choose a folder for saving the CSR file and select Done.

Finalizing the iOS Distribution Certificate

Now that you have the CSR, you can finalize the creation of your iOS Distribution Certificate. To do so:

1. Go back to your Apple Developer account where you started creating the certificate.

2. Click Continue to proceed with the certificate creation.
   

3. Choose the CSR file you generated earlier

4. Follow the on-screen instructions to complete the certificate creation process. The certificate will be created and signed.

5. Once created, download the newly generated certificate. Your new certificate will be displayed in the certificates overview section.

Creating the certificate file to send to Simpplr

To share the certificate with Simpplr, you'll need to export it in a specific format:

Exporting the certificate file

1. Use a Mac. This step requires a Mac. For assistance with other operating systems, please contact your Customer Success Manager.

2. On your Mac, open the Keychain Access program.

3. In the menu bar, navigate to Keychain Access > Import Items.
   

4. Choose the certificate you just created.

5. In the Keychain Access window, locate the certificate in the Certificates overview. Click on the arrow next to the certificate to reveal a second line with the private key.

6. In the menu bar, navigate to File > Export Items.

7. Choose the file format .p12.

8. Select a folder for saving this file and any other files related to this process.

9. Enter a name for the file, ensuring it begins with "distribution_".

10. Select Save to save the file.

Keeping the file for sharing:

Keep this file securely stored as it will be sent to Simpplr as part of the app distribution process.

Production SSL certificate for push notifications

The Production SSL Certificate ensures a secure connection for push notifications sent from the Simpplr server to your app. Follow these steps to set up this certificate:

Apple Developer Account:

1. Sign in to your Apple Developer account and navigate to Certificates, IDs & Profiles > Identifiers > App IDs.

2. Click on the specific app ID you've created for your app. This will display the settings related to this app ID.

3. Click the Edit button.
   

Setting up push notifications:

4. Navigate to the Push Notifications section within the app ID settings.

5. In the Production SSL Certificate section, select Create Certificate.
   

Certificate Signing Request (CSR):

6. To proceed, you'll need a Certificate Signing Request (CSR). At this point, you'll leave the Apple Developer interface and return later after generating the CSR.

Requesting the Signing of the Production SSL Certificate:

7. You'll need access to a Mac for the following steps. If you're using a different operating system, please contact your Customer Success Manager for further support.

8. Open the Keychain Access program on your Mac.

9. In the menu bar, navigate to Keychain Access > Certificate Assistant > Request a Certificate From a Certificate Authority.
   

10. The Certificate Assistant dialog will open.

11. Enter your details as prompted.

12. Click Continue.

13. Select a folder for saving the CSR file.

14. Click Done.

Creating the Production SSL Certificate:

15. Return to your Apple Developer account, specifically where you were setting up the production SSL certificate.

16. Click Continue.

17. Choose the CSR file you generated earlier.

18. Click Continue.

19. Download the newly created production SSL certificate.

20. Click Done. This will take you back to the certificates overview with your new certificate displayed.

To share the production SSL certificate with Simpplr, you'll need to export it in a specific format:

Exporting the certificate file:

21. You'll need a Mac for this step. If you're using another operating system, contact your Customer Success Manager for support.

22. Open the Keychain Access program on your Mac.

23. In the menu bar, navigate to Keychain Access > Import Items.
    

24. Select the production SSL certificate you just created.

25. In the Keychain Access window, go to the Certificates overview.

26. Click on the arrow in front of the certificate to reveal a second line with the private key.

27. In the menu bar, navigate to File > Export Items.

28. Select the file format .p12.

29. Fill in a name for the file, ensuring it begins with push_.

30. Choose a folder for storing this file along with any other files related to this process.

31. Click Save.
    

Keep the file for sending

Ensure you securely store this file, as it will be sent to Simpplr as part of the app integration process.

By following these steps, you'll have successfully prepared the Production SSL Certificate for Push Notifications, ensuring secure communication between Simpplr and your app.

iOS provisioning profile creation

Creating the Provisioning profile of type 'App Store'

1. Sign in to your Apple Developer account and navigate to Certificates, IDs & Profiles > Identifiers > Provisioning Profiles.

2. Add a new provisioning profile.
   

3. Select App Store.
   

4. Click Continue.

5. From the dropdown menu, select the app ID you just created. Click Continue.

6. Select the certificate you just created. Click Continue.

7. Provide a name for your provisioning profile (this name is not visible to end users). Click Generate.

8. Download the provisioning profile.

9. Click Done. This will take you to the provisioning profiles overview with your new provisioning profile displayed.

1. In your Apple Developer account, navigate to Certificates, IDs & Profiles > Identifiers > Provisioning Profiles.

2. Add a new provisioning profile.
   

3. Select Ad Hoc.
   

Creating an app profile in App Store Connect

1. Sign in to App Store Connect and navigate to My Apps.

2. Click on New App. This action creates the profile for your app, which contains all the settings related to your app and the Apple App Store. This creates the profile for the app. The profile will contain all the settings related to the app and the Apple App Store.
   

3. Fill in the app name. Please note that the app name will be reviewed by Apple, and it must comply with Apple's guidelines to avoid potential app rejection.

4. Do not use "employee app" as your app name; Apple prefers apps to have public relevance rather than targeting a single specific group.

5. Set the primary language.

6. Fill in a unique Bundle ID; this ID is not visible to end users.

7. Fill in a unique ID in the SKU field; this ID is also not visible to end users.

8. Click Create.

Send all the app details to Simpplr

From the Apple Developer Account, Simpplr will need:

1. Identifier

2. App Group

3. Share extension idnetifier

4. p8 file: Please share the already generated .p8 file

5. iOS Distribution Certificate File: This should be the file you downloaded and converted to .p12 earlier in the process.

6. iOS Production SSL Certificate File: Similarly, provide the file you downloaded and converted to .p12 earlier for the Production SSL certificate.

7. iOS Provisioning Profile File of Type App Store: Send the provisioning profile file that you downloaded as .mobileprovision and is of type "App Store."

8. iOS Provisioning Profile File of Type Ad Hoc: Include the provisioning profile file downloaded as .mobileprovision, and ensure it is of type "Ad Hoc."

From the App Profile in App Store Connect:

1. Bundle ID: Share the Bundle ID for your app, for example, com.yourcompany.appname.

2. Apple ID: Provide the Apple ID associated with your app. This is a unique identifier, often a numeric value, e.g., 1234567890.

By following these steps, you'll create the necessary provisioning profiles for both App Store and Ad Hoc distribution, and you'll also set up the app profile in App Store Connect. Ensure that all the information provided is accurate and adheres to Apple's guidelines to avoid any potential issues during the app submission and review process.

Additionally, you will also need to provide Simpplr with the .p8 file, the Issuer ID, and the Key ID for Push Notification integration.

Lastly, to complete the app distribution process, Simpplr will require the Team ID to add the appropriate entry in the AASA file (teamID.bundleID).

After this, Simpplr will provide an IPA file to you. Once received, you need to create the listing for app distribution:

Configuring the app information

1. Sign in to App Store Connect and navigate to My Apps.

2. Open the app profile you created earlier.

3. Ensure that all the required languages are set for your app.

4. Double-check the app name to ensure it is accurate.

5. Add a link to the privacy policy for your app.

6. Select appropriate categories for your app. Simpplr suggests selecting Social network and News.

7. Click Save to save these configurations.

Configuring pricing and availability

1. from App Store Connect, navigate to Pricing and Availability.

2. Set the app pricing to free.

3. Adjust the available countries if necessary.

   • If you restrict the availability of your app to certain countries, only employees with app store accounts in those countries will be able to find and download your app in the stores. The geographical location of the employee does not matter for accessing the app store. For example, if your app is only available in the French app store, a US American employee would not be able to see the app. However, a French employee residing in the USA would still be able to download and use the app while being in the USA.

4. Select Available with no discount.

5. Click Save.

Configuring the current version of the app

1. Simpplr provides you with the necessary files and information to fill into your app profile, including screenshots, the version number of your app file, and reviewer sign-in credentials.

2. Navigate to the iOS App current version, which is usually 1.0.

3. For each language:

   • Fill in the app information.

   • Add the store description. Your app needs to have public relevance to be accepted into the Apple App Store. Create a store description that emphasizes:

     • Your company's introduction, field of service, and typical customers.

     • Your app's target audience, such as partners, employees, and customers.

     • The content available in the public area, such as company news, event reviews, and job postings.

     • Features like push notifications.

   • Add more keywords that fit the company name and description.

   • Add the support URL and marketing URL, both of which can be your homepage.

   • Add the screenshots of your app provided by Simpplr. These screenshots are typically made on an iPhone and an iPad.

   • Add the app icon.

   • Adjust the version number to match the one you received from Simpplr.

   • Fill in the Copyright section with your company information.

   • Edit the rating. In most cases, select None or No.

   • Add the reviewer sign-in credentials received from Simpplr.

   • Adjust the release timing if necessary.

4. Click Save.

Submitting the app to the Apple App Store for the first time

1. You need a Mac with the software Application Loader for the following steps. If you are using another operating system, contact your Customer Success Manager for further support.

2. Simpplr provides you with the IPA file.

3. Sign in to App Store Connect.

4. On your Mac, open the Application Loader application.

5. Upload the IPA file. This may take a few minutes. If the upload is successful, you will receive a success message. Apple will now process the app, which may take several minutes until it is available in App Store Connect.

6. In App Store Connect, navigate to the app profile you created.

7. Select the newly uploaded app in the Build section.

8. Double-check all inputs.

9. Click Save.

10. Answer all questions with No.

11. Click Submit. The app is sent to the Apple reviewer, and you can monitor the review status in App Store Connect. After a successful review, the app will be available in the stores immediately or at the specified date.

Ensure that all the information provided is accurate and adheres to Apple's guidelines to avoid any potential issues during the app submission and review process.