SPoT Push API

The SPoT™ location services Push API (“SPoT Push API”) provides access to post-processed data by the Smart Positioning Engine as shown below.

Any third-party access to information available from a SPoT location services deployment must be authorized by the applicable Ruckus licensee. The SPoT Push API is implemented as GPB over MQTT and semantically versioned through the MQTT topic. When backward incompatible changes are made, the version number in the MQTT topic prefix will be incremented.

For the cloud deployment, the base Push API can be accessed (for the current version) via the MQTT protocol via the topic
{version}/LOC/SPOT_GPB/{venue_id}/{data_type}, OR
{version}/LOC/SPOT_GPB/# (to subscribe to Push APIs for multi-venue setup within a single venue server; applicable for vSPoT)

FQDN to MQTT broker publishing the SPoT GPB data: {venue_id}.venue.ruckuslbs.com (e.g. mystadium.venue.ruckuslbs.com), OR IP Address of your vSPoT Server Instance (e.g. 172.30.6.150)

For VM deployments, they will each have their own unique FQDN for MQTT client connection depending on the customer VM setup (which the customer needs to make publicly IP reachable and addressable over port 8883), but the topic name and MQTT Broker PSK port will be the same as above. The PSK Identity and PSK value will be the unique pairs for each venue created by you and assigned by vSPoT (e.g. vspot/3132333435363738, OR {venue_id}/{venue_psk} generated for each venue you created).

MQTT Broker FQDN {venue_id}.venue.ruckuslbs.com, OR IP Address of your vSPoT Server Instance
MQTT Broker Port 8883
PSK Identity A pre-designated pre-shared key identity (as configured in ZD as the venue ID for Location Services definiton) to connect to the Smart Positioning Engine MQTT Broker over TLSv1 PSK encrypted channel
PSK A pre-designated pre-shared key (as configured in ZD as the password for Location Services definiton) to connect to the Smart Positioning Engine MQTT Broker over TLSv1 PSK encrypted channel
Version {version} Current active Push API version in MQTT Topic (defaults to '1.0.0')
Data Type {data_type} Push API data type in MQTT Topic. For GPB Location data, use 'GPB_LOCR'


Copyright Notice and Proprietary Information

Created by Ruckus SPoT Team