imiconnect Developer Hub

Welcome to the imiconnect developer hub. You'll find all the resources to help you get started with imiconnect quickly. We are here to support you if you get stuck. Let's jump right in!

Get Started    API Reference

Set-up a new mobile/web app asset

To leverage our SDKs within your application, you must first create an app asset within the imiconnect platform. The asset configuration determines which SDK features are enabled and available for you to use.

When an app asset is configured the platform will assign an App ID and Client Key. These credentials must be provided to the SDK by your app and form part of the authentication process with the imiconnect platform.

Important!

For enhanced security you should consider implementing JWT authentication.

In order to send push notifications or in-app messages to your app, the asset must be mapped to a service.

Note

Your account administrator should have been provided a URL to the imiconnect Portal, this URL is unique to your account. If you do not have your account URL, please contact your account administrator.

Create a Mobile App Asset in imiconnect

  1. Login to your imiconnect Portal account using your unique account URL.
  2. From the menu bar, go to Assets, and click Apps as shown below.
  1. Click CONFIGURE NEW APP > Mobile / Web.
  1. In the app configuration screen, enter a name for your app and make a note of CLIENT KEY provided within the Access Credentials section.
  1. Within the Push Notifications section, hover over the Platform Type and click Configure to configure OS-specific Push Notification settings.

Note

The information required to configure each platform will vary as it is specific to each platform, but for the sake of this tutorial we will configure push notifications for the Android platform.

Configure Firebase Keys for Android Push Notifications

Android Push Notifications

In the pop-up that appears, provide the FCM Server key and, if supporting Huawei HMS, the Huawei App Id and Secret.
For instructions on where to obtain these pieces of information please refer to Capture the Firebase Server Key and Capture the Huawei App Id and App Secret

Copy the code snippet provided in the 'PERMISSIONS' section and paste it in your manifest.xml file.

iOS Push Notifications

In the pop-up that appears, if you want to use APNS as the Push Notification gateway, provide the Certificate Password, select the gateway type of your APNS project, and provide the certificate file to complete your configuration process. Alternatively, you can use FCM as a gateway. The configurations to use FCM for iOS push notifications is the same as that of Android.

Supported Certificate Format

Currently, .p12 is the only certificate format supported.

Enable In-App Messaging

  1. Enable In-App messaging and select the primary and secondary connection protocol from the select list

Two transport protocols are available for establishing an In-App Messaging connection with imiconnect - Web Socket and MQTT. You can configure them as primary and secondary. If a connection fails to establish on the primary protocol, it falls back to the secondary protocol.

  1. For an end-to-end encrypted messaging service, you must select both the check-boxes (Use Secured Port and Enable Payload Encryption) as shown in the image.

Enable Device Monitoring

Note:

This feature is optional.

  1. To monitor device attributes, like IMEI No., Geo-Location, etc, enable Device Attributes and click Configure as shown below.
  1. In the pop-up that appears, select the device attributes you wish to monitor.
  2. Next, define the monitoring frequency by selecting an interval from the select-list available.
  3. Now copy the code snippet available in the 'PERMISSIONS' section and paste it in your manifest.xml file in case of Android or plist file in case of iOS.
Device Attribute configuration for iOS

Device Attribute configuration for iOS

Device Attribute configuration for Android

Device Attribute configuration for Android

  1. If you want to authorize all communications over in-app messaging, you can do so by enabling JWT Authorization. Once enabled, you'll need to provide the JWT secret key that will be used for validation.

NOTE

To enable JWT authentication for Thread, Topic, and Segment APIs, please reach out to the support team, once you have enabled the above configuration.

  1. By default the Allow Multi User Registrations on Same Device is enabled. If you do not need this feature you can disable this.
  1. Finally, click on SAVE to complete your app asset creation process and hit the back button, to land on the apps page. You can now see your app listed with an App-ID.

You'll have to embed this APP ID in your app code. You can learn more about it in Quickstart guides available in each SDK documentation.

To configure a project, visit Project Setup

Create a Web App Asset in imiconnect

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

  1. From the menu bar, go to Assets, and click Apps .
  2. Click CONFIGURE NEW APP > MOBILE / WEB.
Adding to imiconnect

Adding to imiconnect

  1. Enter the application name and click NEXT.
  2. Select the Web platform and click NEXT. Based on the selected platform, supported browsers screen appears.
  1. Select browser and click NEXT. The app configuration screen appears.
  2. Enter the following fields to configure Chrome and Firefox browsers:
    a. Website URL: Enter the URL of the website to configure Web Push notification.
    b. Notification Icon: Enter the path of the notification icon. The size of the icon should be 80x80.
    c. Web API Key: Enter the API key generated in the section Setup FCM for Chrome and Firefox Browsers
    d. Server Key: Enter the Server key generated in the section Setup FCM for Chrome and Firefox Browsers
    e. Sender ID: Enter the Sender ID generated in the section Setup FCM for Chrome and Firefox Browsers
    f. Click Save.
Configure Chrome and Firefox Push Notifications

Configure Chrome and Firefox Push Notifications

  1. 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 the URL can use your imiconnect ID for push notifications.
    c. Notification Icons: It is mandatory to upload all five icons. Click the respective buttons to upload the icons.
    d. APNS Credentials: 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. Upload the .p12 certificate .
    e. Click Save.
Configure Safari Push Notification

Configure Safari Push Notification

  1. Configure RTM's Transport and Security settings.
Feature
Settings

Real-time messaging

Transport protocols
Two transport protocols are available for establishing RTM connection with imiconnect. They are Web Socket and MQTT. You can configure them as primary and secondary. In case the connection is not established on the primary protocol, it will fall back to secondary protocol.
Security settings
Enable secured ports to establish RTM connection on the secured port for MQTT and WebSocket as an extra layer of security.
Enable RTM payload encryption to encrypt the RTM payload in transit.

  1. 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.
App download for Chrome and Firefox

App download for Chrome and Firefox

App download for Safari

App download for Safari

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

Updated 2 days ago


What's Next

Build your first mobile app.

Android Quickstart Guide

Set-up a new mobile/web app asset


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.