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 on imiconnect

In order to use Push notification and in-app messaging features, you first need to create an app on the imiconnect platform. This app holds information like the FCM API key corresponding to your mobile app. In return, you get an App ID and a client key, which needs to be embedded in your mobile app to link it to the app created on imiconnect.

a
Further to send push notifications or in-app messages, you need to map this app asset 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 New App

  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 Apps > Mobile/Web.
  1. In the app configuration screen, set a name to your app and make a note of CLIENT KEY provided in the section below that.
  1. Next, click Configure as shown in the image to configure OS-specific Push Notification settings.

Configure Firebase Keys for Android Push Notifications

Android Push Notifications

In the pop-up that appears, provide the FCM Server key corresponding to your Firebase project. In the second image below, you can see the section from where you can access the FCM server key from the firebase console.

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

Get your FCM server key

Get your FCM server key

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

  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, you need to raise a request with [email protected] once you have enabled the above configuration.

  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.

Updated 2 months ago


What's Next

Build your first mobile app.

Android Quickstart Guide

Set-up a new mobile/web app asset on imiconnect


Suggested Edits are limited on API Reference Pages

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