Using the HTTP API, access points can send LBS data directly to a freely configurable HTTP endpoint. The data is sent in JSON format, which ensures easy processing at the receiving end.
- HTTP server URL
-
Configure the URL of the HTTP endpoint here.
Note: HTTP and HTTPS are supported. When using HTTPS, certificate verification may be disabled, based on a server certificate, or performed a both ends by server and client authentication. For this purpose, a PKCS#12 container with CA and client certificate can be uploaded to the device that contains the CA certificate or the CA and client certificates. This can be performed using LANconfig or WEBconfig. If no PKCS#12 container is uploaded, no certificate verification is carried out when HTTPS is used.Figure 1. Screenshot WEBconfig
- HTTP server secret
- The HTTP server secret is transmitted in the JSON messages from the access point to the end point and can be used to additionally authenticate the messages.
- HTTP data sources
-
Here you configure whether to transmit WLAN, BLE, or both types of LBS data.
Note: The setting BLE is only supported on devices featuring BLE.
- Source address
- Use this item to configure which loopback address should be used for communication with the HTTP endpoint. This may be necessary if multiple IP networks are configured on the device.
- Measurements fields
-
Here you configure which measurement fields or data from the access point should be included in the messages to the HTTP endpoint. In order to minimize the data volume, we recommend that you limit this to essential data only.
Data format of the messages sent to the endpoint
- For WLAN:
{ "version": "1.0", "secret": "secret", "type": "WLAN", "deviceMac": "00a057000000", "measurements": [ { "clientMac": "334455667788", "seenTime": 1579792598996, "frameSeqNum": 1074, "ssid": "", "module": 0, "bssid": "00a057000000", "rssi": -56, "frequency": 2462, "noise": -70, "frameType": "PROBE" }, { "clientMac": "554433aabbcc", "seenTime": 1579792601334, "frameSeqNum": 2742, "ssid": "", "module": 0, "bssid": "00a057000000", "rssi": -45, "frequency": 2462, "noise": -70, "frameType": "PROBE" } ] }
- version
- The version of the API being used. Currently this is always 1.0.
- secret
- The HTTP server secret specified in the access point configuration.
- type
- The type of data sent. Can be either WLAN or BLE.
- deviceMac
- The LAN MAC address of the access point.
- measurements
- This contains at least one measured value. This could also be a number of measurements.
- clientMac
- The MAC address of the WLAN client.
- seenTime
- The time stamp (in Unix time) when the WLAN frame from the client was received by the access point.
- frameSeqNum
- The sequence number of the received WLAN frame.
- ssid
- The SSID contained in the WLAN frame, if available.
- module
- Describes the access-point WLAN interface that the WLAN frame was received from. Typically 0 for the first WLAN interface or 2 for the second WLAN interface.
- bssid
- The BSSID contained in the WLAN frame.
- rssi
- The signal strength in dBm of the received WLAN frame.
- frequency
- The frequency in MHz of the WLAN channel that the WLAN frame was received on.
- noise
- The noise level in dBm on the channel that the WLAN frame was received on.
- frameType
- The frame type of the received WLAN frame. The following types are available: PROBE, AUTHENTICATION, ASSOCIATION, DEAUTHENTICATION or DEASSOCIATION.
- For BLE:
{ "version": "1.0", "secret": "secret", "type": "BLE", "deviceMac": "00a057000000", "measurements": [ { "deviceAddress": "001122334455", "seenTime": 1579792601269, "addressType": "Random", "rssi": -77 }, { "deviceAddress": "ffeeddccbbaa", "seenTime": 1579792601273, "addressType": "Random", "rssi": -61 "name": "test", "advertisingData": "1eff0600010920024bab81ba8815c5dc61c38449a886740a1ddb09b9e2ad8e", "scanResponseData": "050974657374" } ] }
- version
- The version of the API being used. Currently this is always 1.0.
- secret
- The HTTP server secret specified in the AP configuration.
- type
- The type of data sent. Can be either WLAN or BLE.
- deviceMac
- The LAN MAC address of the AP.
- measurements
- This contains at least one measured value. This could also be a number of measurements.
- deviceAddress
- The address of the BLE device or client.
- seenTime
- The time stamp (in Unix time) when the BLE frame from the client was received by the AP.
- addressType
- The type of BLE address. The following address types are available: Public or Random.
- rssi
- The signal strength in dBm of the received BLE frame.
- name
- The name submitted by the BLE device. Only transmitted if the BLE scanner is activated in the BLE operational settings.
- advertisingData
- The complete advertisement transmitted by the BLE device.
- scanResponseData
- The complete scan response transmitted by the BLE device. Only transmitted if the BLE scanner is activated in the BLE operational settings.