User Manual

Landing Framework

Introduction to the Proximity App

Modules

The Landing Framework offers proximity modules to manage Bluetooth beacons (iBeacon protocol), geofences and scenarios based on proximity to beacons and geofences.

These modules can be found in the Proximity App menu.

Scenarios

With the Scenarios module a user can manage the conditions required for the app to trigger a notification.

Beacons

With the Beacons module a user can manage the beacons which can be used in the Scenarios module.

Geofences

With the Geofences module a user can manage the beacons which can be used in the Geofences module.

Mobile app

In order for users to experience these scenarios, a mobile app is required to trigger push notifications based on the location of the mobile device and show content. You can build your own app based on the API output, or use the Proximity App as a starting point.

API

The app can use 3 different API levels:

  1. Reseller level, proximity data of all users of a reseller: Admin > Resellers > Edit reseller > APIs > Proximity API endpoint and Proximity App > Scenarios > API
  2. User level, proximity data of one user: Proximity App > Scenarions > API > Account
  3. Funnel level, proximity data of the funnel of one user: Proximity App > Scenarions > API > Funnel

Example API output

Beacons, geofences and scenarios (conditions and notifications) are exposed by an API output in the JSON format. A mobile app can process this output

{
  "meta": {
    "timezone": "UTC"
  },
  "geofences": [
    {
      "id": 2,
      "identifier": "Street",
      "lat": "51.42949144290148",
      "lng": "5.489271930078076",
      "radius": 1200
    }
  ],
  "beacons": [
    {
      "id": 2,
      "identifier": "Front door",
      "uuid": "b9407f30-f5f8-466e-aff9-25556b57fe6d",
      "major": 123,
      "minor": 777,
      "lat": "23.01798504517085",
      "lng": "72.555052042007450"
    },
    {
      "id": 3,
      "identifier": "Office",
      "uuid": "b9407f30-f5f8-466e-aff9-25556b57fe6d",
      "major": 3623,
      "minor": 64141,
      "lat": "51.47530345330867",
      "lng": "5.571155275402930"
    }
  ],
  "scenarios": [
    {
      "id": 3,
      "scenario_if_id": 1,
      "scenario_then_id": 4,
      "day_time": {
        "mon": [
          "00:00:00-23:59:59"
        ],
        "tue": [
          "00:00:00-23:59:59"
        ],
        "wed": [
          "00:00:00-23:59:59"
        ],
        "thu": [
          
        ],
        "fri": [
          
        ],
        "sat": [
          
        ],
        "sun": [
          
        ]
      },
      "time_start": null,
      "time_end": null,
      "date_start": null,
      "date_end": null,
      "frequency": 0,
      "delay": 0,
      "notification_title": "Green Food",
      "notification_message": "We have the best food for your health. Come visit us, you're nearby!",
      "app_image": "https://lf.nowsquare.com/uploads/Xl/green-food.jpg",
      "open_url": "https://nowsquare.com",
      "geofences": [
        
      ],
      "beacons": [
        2,
        3
      ]
    }
  ]
}