Installation

Goals

1. Enable your iOS application to send and receive push notifications through Apple Push Notification Service (APNs) and configure it for Mapp Engage.

2. Enable the iOS channel in Mapp Engage to deliver push notifications and in-app messages via the configured app.

Requirements

• iOS Version Support:

  • SDK 6: Supports iOS 10.0–16.0

  • SDK 5: Supports iOS 8.0–11.0

  • SDK 4: Supports iOS 8.0–10.0

• Xcode Requirements:

  • Base SDK: iOS 10 or above

  • Deployment Target: iOS 8 or above

Download

Download the latest version of the iOS SDK:

Installation

A) Enable Apple Messaging for Mapp Engage

Prerequisites

• Access to the Apple Developer Member Center.

• A valid Apple Developer Account.

• Explicit App ID (Bundle Identifier) for your application.

• Installed Xcode with the application project ready for configuration.

Procedure

1. Log In to the Apple Developer Member Center

   • Navigate to Apple Developer Member Center.

   • Use your Apple ID and password to sign in.

2. Register an Explicit App ID

   • Navigate to Certificates, Identifiers & Profiles > Identifiers > App IDs.
     

     ---

     
     
     

   • Select + to create a new App ID.

   • Enter your application details:

     • Description: Enter a name for your App ID (e.g., MyApp).

     • Bundle ID: Use the Bundle Identifier of your app from Xcode (e.g., com.example.myapp).

     

   • Under Capabilities, ensure that Push Notifications is enabled.
     

   • Save your App ID.

   • More information: Set the bundle ID and Register an App ID.

3. Enable Push Notifications for Your App

   • Under your newly created App ID, click Edit.

   • In the App Services section, enable Push Notifications.

   • Click Save.

   • More information: Enable push notifications.

4. Create an APN SSL Certificate

   • Under Certificates, Identifiers & Profiles, go to Certificates > +.
     

   • Select Apple Push Notification Service SSL (Sandbox & Production) and click Continue.
     

   • Choose the App ID you created earlier.
     

   • Follow the on-screen instructions to upload a Certificate Signing Request (CSR):

     • Open Keychain Access on your Mac.

     • Go to Keychain Access > Certificate Assistant > Request a Certificate from a Certificate Authority.

     • Fill in the required details and save the CSR file to your system.

   • Download the APN certificate and double-click it to add it to your Keychain.

   • More information: Create Developer ID certificates.

5. Export the p12 Certificate

   • Open Keychain Access.

   • Locate your APN certificate under the My Certificates section.

   • Right-click and select Export.

     

   • Save it as a .p12 file and set a secure password.

     

     

   • More information: Establishing a certificate-based connection to APNs.

6. Token-Based Authentication (Optional)

   • If you prefer token-based authentication, create a .p8 key from the Keys section under Certificates, Identifiers & Profiles.

   • Save the .p8 file securely as it will not be retrievable again.

   • More information: Establishing a token-based connection to APNs.

7. Add the Certificate to Mapp Engage

   • Share the .p12 or .p8 certificate with your Mapp Project Manager.

   • Provide the following details:

     • Certificate Password (if using .p12).

     • Bundle ID associated with the certificate.

     • Indicate whether the certificate is for Development or Production.

     • For more information, see iOS Authentication Certificates and Tokens.

8. Update Provisioning Profiles

   • If creating the certificate invalidates existing provisioning profiles, regenerate and update them in Xcode.

   • More information: Developer Account Help.

B) Enable iOS Channel in Mapp Engage

Prerequisites

• Completion of Step A: Enable Apple Messaging for Mapp Cloud.

• Access to the Mapp Engage admin interface.

Procedure

1. Log In to Mapp Engage and navigate to Channel Settings:

   • From the top menu, go to Administration > Channels > App.

2. Create or Select an iOS Channel

   • Click Create App Channel.

   • Name the app channel and optionally add a description

   • Select iOS as the channel type and click Next.

     

3. Configure Channel Parameters:

   • In the Configure iOS Channel section, fill in the following details:

     • App Store ID: (Optional) Enter your app’s App Store ID.

     • Bundle ID: Enter the same Bundle Identifier used in Xcode and for the APNs certificate.

       

   • Environment: Choose between Production or Development based on the certificate type.
     

   • Add Notification Sounds (Optional)

     • To add custom sounds for notifications:

       • Add the sound files to your project in Xcode.

       • Reference these sound names in the channel configuration.

       

   • Add Buttons (see Create Localized Button Sets)

     

   • Enable Push Notifications and In-App Messages: use the toggle options
     

4. Certificate File: Upload the .p12 or .p8 file generated in Step A.
   For .p12:

   • Enter the certificate password
     
     

   For .p8:

   • Enter the Key ID and Team ID

5. Save and Activate the Channel

   • Click Save to store the configurations.

   • After saving, click Activate to enable the channel.

Keep in mind:

• If you encounter errors during configuration, verify that the uploaded certificate matches the Bundle ID and environment.

• For troubleshooting, consult the Testing and Troubleshooting SDK Integration section in this documentation.

Next Step: Integration

To proceed, follow the Integration Guides.