Magic Touch API

The Accuware Magic Touch API, is a fast and easy way to identify all the Wi-Fi enabled device (such as smartphones, tablets, laptops and Wi-Fi tags), with an RSS greater or equal to a specific RSS threshold, seen in proximity of a specific node of your site. You just need to issue a special HTTP GET request to the Accuware server. The Accuware server will then hang the request until either:

  • the timeout elapses (if specified);
  • or at least one device matches the specified RSS criteria (the RSS is greater or equal to a specific threshold).

The Accuware Magic Touch server supports HTTP data compression allowing thus a better use of available bandwidth between your client and our server and providing in the end a greater transmission speeds between both.

In order to make use of the compression you have to includes the following supported compression schema in the header of the HTTP request:

More information in this page.

api/v1/sites/{site_id}/nodes/{node_mac}/magictouch/

GET

Resource-wide template parameters:

  • {siteId}: site identification string
  • {node_mac}: the MAC address of the Open Mesh node used to detect all the Wi-Fi enabled devices.

Query parameters:

  • rss (default -30 dBm, if not specified): a value greater or equal to -110  dBm (extremely far to the node) and less or equal to 0 dBm (extremely near to the node) specifies the RSS threshold, which needs to be reached in order to consider a device as in proximity to the node. At this link you can find more information about the RSS.
  • timeout (default 30 seconds, if not specified): a value greater than 0 seconds and less than or equal to 30 seconds which defines the maximum time the Magic Touch API will be hung.
  • blacklist (optional): list of fully or partially specified MAC addresses which will not be returned in the list of Wi-Fi devices detected by the node. The blacklist can be used for example to filter out the Wi-Fi interfaces of the nodes or of any other manufacturer from the device list returned by the nodes.

The manufacturers/vendors of Wi-Fi interfaces can be identified by using the first six digits of the MAC addresses. In this page it is possible to find a complete list of manufacturers and prefixes from an official repository.

Available response representations:

  • 200 OK – application/json
  • JSON list of device’s MAC addresses along with their current RSS value.

Example:

Identify all the Wi-Fi-enabled device very close (RSS >=-40 dBm) to the node with MAC address 00:11:22:33:44:55 inside site 1000 and hang this detection request for 10 seconds:

The result is a JSON list of device’s MAC addresses along with their current RSS value:

The result is an empty JSON if no device did match and timeout is reached: