Real-time Data Sync

Create your Firebase project

To add Zone data sync support to your application you will need to add Firebase to your app, you will need to create a Firebase project. This can be achieved by the following steps:

1. If you don’t have a Google Firebase account, then create a free account by clicking on the Get started for free button on the home page of Firebase website.
2. You can register for a Firebase account using a Gmail account.
3. Create a new Firebase project in the Firebase console, if you have an existing Google project associated with your mobile app, you can import it by selecting Import Google Project. To create a new project click on Create New Project.
4. A new dialog will appear, enter your project’s name and select your country/region and click on the Create Project button.
5. You will be taken to your Firebase project page.
6. Navigate to the Project settings page by selecting the settings icon next to the project name and then select the Project settings link in the navigation menu.
7. Navigate to the CLOUD MESSAGING tab.
8. Here you will find the Server key under the Project credentials section, which is required to be added to your Bluedot Project on Canvas.

Setup Firebase API key for your Bluedot project

Create a new Project and add the Firebase Web API Key for it

1. Login into Canvas
2. Choose Project from the menu in the top right corner
3. Tap the Edit Details button
4. Add the Firebase API Key
5. Update

Enter the Firebase Web API Key from the Firebase project setting to the Firebase API Key field. Using this key we will be able to communicate with Firebase to deliver the zones that need to be synced.

Sync Zones updates to mobile applications

The new zone updates are synced every 5 mins to the mobile devices.

Canvas Zone updates

The newly added, updated or deleted zones from Canvas will be automatically synced to all your mobile devices using the Firebase API Key that was added to the Project details.

Config API Zone updates

By default, all Zones created, updated or deleted via the Config API are not automatically synced to the mobile devices.

If you wish for newly created or updated Zones to be synced immediately to the mobile devices then add the shouldSync field in the POST and PUT JSON requests.

The API specification for Zones can be found here.

Sample POST JSON request:

{
    "name": "Sample fence",
    "minimumRetriggerTime": 3600,
    "geofeatures": [{
        "name": "Sample fence",
        "radius": 40,
        "center": {
            "latitude": -37.818036,
            "longitude": 144.9775493
        },
        "color": "#429BD5",
        "type": "circle",
    }],
    "projectId": "6e4aeb98-05b3-4b3f-b9ac-3b9a169e395c",
    "triggerOnExit": false,
    "shouldSync": true
}

If you wish for deleted Zones to be synced immediately to the mobile devices then add shouldSync as a parameter in the DELETE request.

{Base Config API URL}/zones/{zoneId}?shouldSync=true

Bulk zone updates

For bulk Zone updates via API scripts we suggest setting the shouldSync value to false in the Zone requests, this is to avoid multiple real-time data sync push messages sent to mobile devices.

If your use case requires all Zones updates to be immediately synced to the mobile devices, please contact Bluedot helpdesk to discuss possible options.

Integrate real-time data sync in your applications

• Android
• iOS