destination.one: Besucherstromlenkung - Partnerschnittstelle für Messwerte

destination.one: Besucherstromlenkung - Partnerschnittstelle für Messwerte

Die Messwertquellen für die Besucherstromlenkung sind destination.box in der WiFi-Tracker Edition vor Ort, aber es ist auch möglich "Third Party" Messwerte in destination.data zu integrieren. Ebenfalls ist es möglich, die Messwerte von destination.boxen an Partnersysteme weiterzuleiten.

Senden von Messwerten an destination.data

Die Übermittlung von Messwerten erfolgt via "Push" damit die Daten möglichst aktuell sind.
Das Intervall in dem die Daten gesendet werden, kannst Du anhand dem Intervall der Sensorhardware, z.B. 5 oder 15 Minuten, festlegen.
Bitte beachte, dass Messwerte, die älter als 1 Stunde sind, nicht mehr beachtet werden.

REST API



Method
POST
Endpoint
Body
JSON Paket siehe unten

clientid = Ihre Client-ID. 
Bitte kontaktiere uns für die Zugangsdaten zur API, bestehend aus Client-ID (Username) und API-Key (Password).

Authentifizierung

Die Authentifizierung erfolgt via HTTP Basic Authorization.

HTTP Header Feld
Wert

Authorization

Basic base64encode($clientid:$apikey)


JSON Format
  1. {
  2. "installationId": "prefix-12345",
  3. "type": "people-counter",
  4. "experience": "st-peter-ording",
  5. "terminal": "Seebrücke",
  6. "timestamp":"2020-07-24T10:38:44Z",
  7. "traffic": {
  8. "value": 5
  9. },
  10. "thresholds": {
  11. "alert": 50,
  12. "warn": 100
  13. }
  14. }

Parameter
Beschreibung
installationId
(string) Eindeutige ID des Geräts/Abschnitts. Partner-spezifisches Prefix. max 40 Zeichen
type
(string) people-counter
experience
(string) Experience(Projekt) des Kunden
terminal
(string) Name der Messstation
timestamp
(string) Zeitpunkt der Messung
traffic.value
(int) Messwert (Anzahl WLAN Geräte, Personen, etc.)
thresholds.alert
(int) Schwellwert ab wann hohe Aulastung/Rot
thresholds.warn
(int) Schwellwert ab wann mittlere Auslastung/gelb

Empfangen von Messwerten von Wifi-Tracker destination.boxen

Wenn Du die Messwerte von unserem Wifi-Tracker in Echtzeit in deinem System erhalten möchtest, benötigen wir die URL deines API Endpunktes.
Wichtig:
​Dein Endpunkt muss hierbei den Empfang eines JSON Objekts per POST im Format, ähnlich wie oben unter "Senden" dokumentiert, unterstützen.
JSON Format

  1. {
  2.     "experience": "st-peter-ording",
  3.     "installationId": "cb393d08-xxxx-xxxx-xxxx-xxxxxxxxxxxx-wt",
  4.     "terminal": "touristinfobad",
  5.     "thresholds": null,
  6.     "timestamp": "2020-07-24T10:38:44Z",
  7.     "traffic": {
  8.         "value": 14
  9.     },
  10.     "type": "wifi-tracker"
  11. }

Parameter
Beschreibung
installationId
(string) Eindeutige ID des Wifi Trackers
type
(string) wifi-tracker|people-counter
Unterschied zu oben destination.box Wifi Tracker haben als type wifi-tracker, alle anderen Geräte people-counter
experience
wie oben
terminal
wie oben
timestamp
wie oben
traffic.value
wie oben
thresholds
Unterschied zu oben Wird nicht mitgeliefert, da die Schwellwerte nicht beim Sensor sondern beim POI gepflegt werden und hier bei der Echtzeitübermittlung von Sensordaten nicht enthalten ist.

Es ist möglich die Schwellwerte via destination.meta abzuholen falls die Wifi Tracker bereits einem POI zugeordnet sind (Mehrfachzuordnung möglich):
Beispiel:
http://meta.et4.de/rest.ashx/search/?experience=st-peter-ording&q=peoplecount%3A%5B0+TO+3%5D&template=ET2014A.xml
PeopleCounterThresholdMedium, PeopleCounterThresholdHigh