Knowledge Base

Beacon API

Tags:   beacon 


The following information is provided to enable App Developers to build Android and iOS Applications to either:

  1. Interrupt on screen Digital Sigange content based on mobile phone detection
  2. Push content to the mobile device


To view the content of the beacon, you can call a URL which will display HTML5 content. The URL should be constructed as follows:
Or the URL for testing should be:
BEACON_KEY should be | delimited and contain the UUID, major and minor.
Example: 123432432|1|1
When a beacon is scanned, Engage will need to know the UUID that was scanned. If major and minor are available, EngagePHD can use those as well if beacons have the same UUID, the major/minor must be different. If the UUID is scanned and major/minor are not available, send major and minor as 1 to EngagePHD.
Under the layout properties and Beacons tab, you can configure which beacons this layout will show. A Phone layout can be used to determine if you want a different layout to show on the mobile device. A player interrupt can also be specified to interrupt the player as the person walks by. With this, you can send Engage the name of the person and we can show that on the player interrupt using the product named "Beacon" with attributes Name1, Name2, Name3, Name4, Name5, Name6, Name7. If a Phone layout is not specified, the device will show the current layout that is configured for that beacon.
The lang parameter is optional but can be used to display language specific layouts. For example, in Android, to get the language code, you can call Locale.getDefault().getISO3Language() and pass that in the language parameter. Then in the layout beacons tab, you can enter the beacon but prefix it with the language code so different layouts can be created for the same beacon to display different language. For beacon 123432432 you can configure that as the default as well as have eng123432432 with the major and minor or fra123432432 for French.
If you send the name, you can have a timer and then call another URL for that name to drop off of the name attributes list above.