Quickstart Guide

To send web push notifications, the client website must be configured to show the popup. The pop-up appears when the customer's navigate to the website. When the customers accept to receive web push notifications, a service worker is created in the browser's background. The service worker constantly listens to the push messaging server and shows the notification even when the website is closed.

📘

Web push notifications are not supported in private browsing mode.

Prerequisites

The minimum requirements to use IMIconnect JavaScript SDK are:

Web push notifications are supported on the following OS and browsers:

Configuration Tasks

• Setup FCM for Chrome and Firefox Browsers
• Setup APNs for Safari Browser
• Add Web Application in IMIconnect
• Download and Integrate JavaScript SDK in your Website
• Sending Push Messages to Customers

Setup FCM for Chrome and Firefox Browsers

To create Google API project, follow these steps:

1. Go to Google Firebase Console.
2. Click Add Proejc.

3. Add the following in the screen that appears:
   • Project name: Enter a name for your project.
   • Country/region: Select the country name.
   • Select the Default setting and Terms and conditions check-box
4. Click CREATE PROJECT. to continue.

• The console will create a project with the given details.
• Click Continue to proceed.

5. On overview page, Click icon text toProject Overview

6. The project setting details are displayed, copy the Web API Keyin IMIconnect Web APP setting Page

7. Click on Cloud Messaging.
   While creating chrome/Firefox app, you can enter either the Legacy server key or the Server Key in the API Key and Sender ID for Project number.

The API Key can either be the Legacy server key or the Server Key.

The snippet contains initialization information to configure the Firebase JavaScript SDK to use Authentication, Cloud Storage and the Realtime Database.
User can take the apikey and messagingSenderId to create a web push chrome application.

Setup APNs for Safari Browser

The following steps will guide you through the process of APNs setup, certificate creation, and configuration.

1. Go to the Apple Developer Portal.
2. Proceed to Certificates, Identifiers & Profiles. The screen will display all the certificates configured for your applications.

📘

Certificates are configured within the Certificates section.

3. Click the + button to add a new certificate. A screen is displayed to select a certificate for your environment.

4. Select the Apple Push Notification service SSL (Production) option.

5. Select your App ID from the drop-down list.

📘

If an App ID is not available, a new App ID must be created.

6. Click Continue.

Create Certificate Signing Request (CSR)

1. Follow the on screen instructions to create a Certificate Signing Request, Generate, and Approval.
2. Click Continue.

Follow the below steps if you need further assistance in Certificate Signing Request, Generate, and Approval explained in the above screen.

Launch Keychain Access

1. To launch Keychain Access from an Apple Mac:
   a. Open spotlight: cmd + space key.
   b. Type Keychain Access. The Keychain Access screen is displayed.
2. Select Request a Certificate from a Certificate Authority option.

📘

The Certificate Assistant will appear to help you create the request.

Create Certificate

Within the Certificate Assistant complete the following steps:

1. Enter the following details for your certificate:
   a. User Email Address: Enter email address that matches with the Apple developer account ID.
   b. Common Name: A name for your certificate.

📘

Do not enter CA Email.

2. Select Request is: -> Saved to disk option.

3. Click Continue to save the certificate on to your Mac.

Submit Request

To submit a Certificate Signing request, return to the Apple Developer Portal.

1. Click Choose File and select the certificate file that was created in the previous step.

2. Click Generate.

The Apple Push Notification service SSL certificate is generated.

Download Certificate

Once the APNs SSL certificate has been generated it is ready to be downloaded.

1. Click Download to download the certificate.

Add Certificate to Keychain

1. Open the certificate to install it to your Keychain.
2. Within Keychain Access:
   • Select the login keychain and the category as My Certificates.
   • Locate and select the certificate.
   • Right-click and select Export .
   • Save the certificate as a .p12 file.

3. A password screen appears. Click OK. The certificate must be saved without a password.

📘

When the certificate is created, it is used in IMIconnect to configure push notification service.

Add Web Application in IMIconnect

To add a web application in IMIconnect, follow these steps:

1. From the IMIconnect menu, click Apps. The Application screen appears.
2. Click CONFIGURE APPS > MOBILE / WEB.

3. Enter the application name and click NEXT.

4. Select the Web platform and click NEXT. Based on the selected platform, supported browsers screen appears.
5. Select browser and click NEXT. The app configuration screen appears.
6. Select Push Messaging or Real Time Messaging channel.
7. Enter the following fields to configure Chrome and Firefox browsers:
   a. Site Name: Enter the URL of the website to configure Web Push notification.
   b. API Key: Enter the API key generated in the section Setup FCM for Chrome and Firefox Browsers.
   c. Project number: Enter the project number generated in the section Setup FCM for Chrome and Firefox Browsers .
   d. Notification Icon: Enter the path of the notification icon. The size of the icon should be 80x80.
   e. Click Save.

8. Enter the following fields to configure Safari browser:
   a. Site Name: The name that is entered is displayed on the notification.
   b. Site URL: The URL that is used to validate the identity of the website requesting push notifications using your ID. Only the website that matches with the URL can use your IMIconnect ID for push notifications.
   c. APNs keys: Click the button to upload the .p12 file that is generated in the section Setup APNs for Safari Browser.
   d. Password: Enter the password that is set while generating the certificate in the section Setup APNs for Safari Browser. Leave this field blank if the certificate was generated without a password.
   e. Notification Icon: It is mandatory to upload all five icons. Click the respective buttons to upload the icons.
   f. Click Save.

9. Configure RTM's Transport and Security settings.

10. Click Save.

A confirmation message appears when the application is created successfully.

Download and Integrate JavaScript SDK

1. When the web app is added successfully, you can notice a DOWNLOAD link under Web configuration section. Click the link to download the JavaScript SDK.

2. Extract the zip file, to a location in your local computer. You will notice js, manifest folders and sw.js file.
3. Copy sw.js file, js, and manifest folder to the root folder of your web application.
4. Copy the below code and paste it in header or body of your default web page. Replace appId with your actual value.

For example, to show the web push popup on loading the index.html page, copy the below code and paste it in header or body of your index.html page. Replace the appId with the id that is generated in IMIconnect for the web application.

<script src="../js/jquery.min.js"></script>
<script src="//www.gstatic.com/firebasejs/4.6.2/firebase-app.js"></script>
<script src="//www.gstatic.com/firebasejs/4.6.2/firebase-messaging.js"></script>
<script src="../js/mqttws31.js"></script>
<script src="../js/IMIClient.js"></script>
<script>
    try {
        var config = new IMI.ICConfig(appId, clientKey);
        IMI.IMIconnect.startup(config);

        if (!IMI.IMIconnect.isRegistered()) {
            var callback = {
                onSuccess: function() {
                    console.log("reg success");
                    //logic to subscribe to topics or publish messages
                },
                onFailure: function(errormsg) {
                    console.log("reg failed");
                }

            };
            var deviceProfile=new IMI.ICDeviceProfile(deviceId, userId);  
           //here user id is  optional (If user id not there user can call deviceID,  
             userId will be generated by IMIConnect and passed to callback function)//
          //var  deviceProfile = new IMI.ICDeviceProfile(deviceId);//
          IMI.IMIconnect.register(deviceProfile, callback);
        }
    } catch (err) {
        console.log(err);
    }
</script>

<script src="../js/jquery.min.js"></script>
<script src="../js/mqttws31.js"></script>
<script src="../js/IMIClient.js"></script>
<script>
    try {
        var config = new IMI.ICConfig(appId, clientKey);
        IMI.IMIconnect.startup(config);

        if (!IMI.IMIconnect.isRegistered()) {
            var callback = {
                onSuccess: function() {
                    console.log("reg success");
                    //logic to subscribe to topics or publish messages
                },
                onFailure: function(errormsg) {
                    console.log("reg failed");
                }

            };
            var deviceProfile=new IMI.ICDeviceProfile(deviceId, userId);  
           //here user id is  optional (If user id not there user can call deviceID,  
             userId will be generated by IMIConnect and passed to callback function)//
          //var  deviceProfile = new IMI.ICDeviceProfile(deviceId);//
          IMI.IMIconnect.register(deviceProfile, callback);
        }
    } catch (err) {
        console.log(err);
    }
</script>

Now the web push configuration is complete to display a popup when the default web page is loaded.

5. When the web page is loaded a popup appears. When user clicks on Allow, unique ids are generated and stored in profile manager. The ids generated are:

6. To send messages without a customerid, you must use browser specific pushids.

Sending Push Messages to Customers

You can send push messages to customers in many methods. Below is one of them:

1. When the customers click Allow button, the push details are stored in profile manager.
2. Get the profiles based on appid using getAppProfile API. You will get all the browser specific push ids.
3. Use Messaging API, to send push messages to the push ids.