Bei Webhooks handelt es sich um HTTP Trigger, die bei einem Event geschickt werden. Mit diesem Event können Daten versendet werden, die es ermöglichen Fremd-APIs anzusteuern. Der Aufbau der Daten kann frei bestimmt werden. Die veränderlichen Nutzdaten werden mithilfe von Variablen eingefügt. Diese werden zum Zeitpunkt der Auslösung ersetzt.
Alle hier dargestellten API- und SNMP Beispiele beziehen sich auf die zum Zeitpunkt der Erstellung des Artikes aktuellen Versionen der jeweiligen Produkte. Diese unterliegen fortlaufender Entwicklung. Die jeweils gültigen Daten finden Sie in der API Dokumentation hier.
Die ReST API sowie die SNMP Schnittstellen werden der Dokumentation entsprechend ausgeliefert. KENTIX setzt bei Verwendung dieser Schnittstellen grundsätzliche Kenntnisse dieser Technologien beim Anwender voraus.
Um Sie optimal bei der Umsetzung ihrer individuellen Projektanforderungen zu unterstützen, bieten wir passende Support-Pakete an. Ein entsprechendes Zeitkontingent können sie einfach im Kentix Shop buchen.
Beispiele und mögliche Variablen
AccessManager
Mögliche Variablen
- $USERID$ = ID des Benutzers
- $USERNAME$ = Login Name des Benutzers
- $USERFULLNAME$ = Voller Name des Benutzers
- $USERMAIL$ = E-Mail Adresse des Benutzers
- $RFIDUID$ = RFID Uid der Karte mit welcher gebucht wurde
- $RFIDDATA$ = RFID Daten der Karte mit welcher gebucht wurde
- $PIN$ = Eingegebene PIN
- $TIME$ = Zeit des Events als Text String
- $UNIXTIME$ = Zeit des Events als UNIXTIME
- $STATE$ = Status der Buchung (0: Zutritt Ok, 1: RFID unbekannt, 2: PIN unbekannt, 3: Doppelauthentifizierung fehlgeschlagen, 4: Ausserhalb des Zeitprofils, 5: Keine Türberechtigung, 6: Authentifizierungsfehler)
- $DOORID$ = ID der Schließeinheit
- $DOORNAME$ = Name der Schließeinheit
- $DOORSERIAL$ = Seriennummer der Schließeinheit
- $IP$ = IP-Adresse des Gerätes
- $MAC$ = MAC-Adresse des Gerätes
- $SERIAL$ = Seriennummer des Gerätes
Beispiel
{
"time": "$TIME$",
"user": "$USERNAME$",
"rfid": "$RFID$",
"pin": "$PIN$",
"state": "$STATE$",
"door": "$DOORNAME$"
}
AlarmManager
Mögliche Variablen
- $DEVICE_ID$ = ID des Geräts
- $DEVICE_NAME$ = Name des Geräts
- $DEVICE_ADDRESS$ = Adresse des Geräts
- $MAC$ = MAC-Adresse des Gerätes
- $SERIAL$ = Seriennummer des Gerätes
- $ALARMZONE_ID$ = ID der Alarmzone
- $ALARMZONE_NAME$ = Name der Alarmzone
- $ALARMZONE_STATE$ = Status der Alarmzone
- $BUILDING_ID$ = ID des Gebäudes
- $BUILDING_NAME$ = Name des Gebäudes
- $INPUT_VALUE[1]$ (1-16) = Messwert des gewählten Eingangs (1-16)
- $INPUT_ALARM[1]$ (1-16) = Alarmzustand des gewählten Eingangs (1-16)
- $BATTERY_LEVEL$ = Ladezustand der Batterie
- $BATTERY_VOLTAGE$ = Spannung der Batterie
- $BATTERY_ALARM$ = Alarmzustand der Batterie
- $CO_VALUE$ = Messwert des CO-Sensors
- $CO_ALARM$ = Alarmzustand des CO-Sensors
- $DEWPOINT_VALUE$ = Messwert des Taupunktsensors
- $DEWPOINT_ALARM$ = Alarmzustand des Taupunktsensors
- $HUMIDITY_VALUE$ = Messwert des Luftfeuchtigkeitssensors
- $HUMIDITY_ALARM$ = Alarmzustand des Luftfeuchtigkeitssensors
- $LATENCY_VALUE$ = Messwert der Serverüberwachung
- $LATENCY_ALARM$ = Alarmzustand der Serverüberwachung
- $MOTION_VALUE$ = Messwert des Bewegungssensors
- $MOTION_ALARM$ = Alarmzustand des Bewegungssensors
- $REED_VALUE$ = Messwert des Türkontakts
- $REED_ALARM$ = Alarmzustand des Türkontakts
- $CONNECTION_VALUE$ = Messwert der Verbindungsüberwachung
- $CONNECTION_ALARM$ = Alarmzustand der Verbindungsüberwachung
- $EXTPOWER_VALUE$ = Messwert der Stromversorgung
- $EXTPOWER_ALARM$ = Alarmzustand der Stromversorgung
- $TEMPERATURE_VALUE$ = Messwert des Temperatursensors
- $TEMPERATURE_ALARM$ = Alarmzustand des Temperatursensors
- $TILT_VALUE$ = Messwert des Sabotagesensors
- $TILT_ALARM$ = Alarmzustand des Sabotagesensors
- $VIBRATION_VALUE$ = Messwert des Vibrationssensors
- $VIBRATION_ALARM$ = Alarmzustand des Vibrationssensors
- $SNMP_VALUE$ = Messwert der SNMP Abfrage
- $SNMP_ALARM$ = Alarmzustand der SNMP Abfrage
- $TIME$ = Zeit des Events als Text String (Wie KPM, KXP)
- $UNIXTIME$ = Zeit des Events als UNIXTIME (Wie KPM, KXP)
Beispiel
{
"time": "$TIME$",
"building": "$BUILDING_NAME$",
"alarmzone": "$ALARMZONE_NAME$",
"alarmzone-state": "$ALARMZONE_STATE$",
"device": "$DEVICE_NAME$",
"address": "$DEVICE_ADDRESS$",
"temperature": "$TEMPERATURE_VALUE$",
"temperature-alarm": "$TEMPERATURE_ALARM$",
"humidity": "$HUMIDITY_VALUE$",
"humidity-alarm": "$HUMIDITY_ALARM$",
"dewpoint": "$DEWPOINT_VALUE$",
"dewpoint-alarm": "$DEWPOINT_ALARM$",
"fire": "$CO_VALUE$",
"fire-alarm": "$CO_ALARM$",
"intrusion": "$MOTION_VALUE$",
"intrusion-alarm": "$MOTION_ALARM$",
"vibration": "$VIBRATION_VALUE$",
"vibration-alarm": "$VIBRATION_ALARM$",
"input1": "$INPUT_VALUE[1]$",
"input1-alarm": "$INPUT_ALARM[1]$",
"input2": "$INPUT_VALUE[2]$",
"input2-alarm": "$INPUT_ALARM[2]$",
"connection": "$CONNECTION_VALUE$",
"connection-alarm": "$CONNECTION_ALARM$",
"extpower": "$EXTPOWER_VALUE$",
"extpower-alarm": "$EXTPOWER_ALARM$"
}
PowerManager
Mögliche Variablen
- $TIME$ = Zeit des Events als Text String
- $UNIXTIME$ = Zeit des Events als UNIXTIME
- $NAME$ = Name des Smartmeters
- $ADDRESS$ = Adresse des Smartmeters
- $RCM_AC$ = AC Messwert des Differenzstrommessers
- $RCM_AC_ALARM$ = AC Alarmstatus des Differenzstrommessers
- $RCM_DC$ = DC Messwert des Differenzstrommessers
- $RCM_DC_ALARM$ = DC Alarmstatus des Differenzstrommessers
- $POWER_FAILURE_ALARM$ = Stromausfall Alarm des Smartmeters
- $IP$ = IP-Adresse des Gerätes
- $MAC$ = MAC-Adresse des Gerätes
- $SERIAL$ = Seriennummer des Gerätes
- Phasen Variablen (Diese werden mit [] indiziert)
- $PHASE_NAME[1]$ = Name der Phase
- $PHASE_NUMBER[1]$ = Nummer der Phase
- $PHASE_VOLTAGE[1]$ = Messwert der Spannung
- $PHASE_VOLTAGE_ALARM[1]$ = Alarmstatus der Spannung
- $PHASE_CURRENT[1]$ = Messwert der Stromstärke
- $PHASE_CURRENT_ALARM[1]$ = Alarmstatus der Stromstärke
- $PHASE_POWER_ACTIVE[1]$ = Messwert der Wirkleistung
- $PHASE_POWER_ACTIVE_ALARM[1] = Alarmstatus der Wirkleistung
- $PHASE_POWER_REACTIVE[1]$ = Messwert der Blindleistung
- $PHASE_POWER_REACTIVE_ALARM[1] = Alarmstatus der Blindleistung
- $PHASE_POWER_APPARENT[1]$ = Messwert der Scheinleistung
- $PHASE_POWER_APPARENT_ALARM[1]$ = Alarmstatus der Scheinleistung
- $PHASE_POWER_FACTOR[1]$ = Leistungsfaktor
- $PHASE_FREQUENCY[1]$ = Messwert der Frequenz
- $PHASE_FREQUENCY_ALARM[1]$ = Alarmstatus der Frequenz
- $PHASE_CONSUMPTION[1]$ = Aktueller Stromverbrauchswert
- $PHASE_FUSE_ALARM[1]$ = Alarmstatus einer Sicherung
Beispiel
{
"time": "$TIME$",
"name": "$NAME$",
"address": "$ADDRESS$",
"rcm":
{
"ac":
{
"value": "$RCM_AC$",
"alarm": "$RCM_AC_ALARM$"
},
"dc":
{
"value": "$RCM_DC$",
"alarm": "$RCM_DC_ALARM$"
}
},
"power_failure": "$POWER_FAILURE_ALARM$",
"phases":
[
{
"name": "$PHASE_NAME[1]$",
"number": "$PHASE_NUMBER[1]$",
"voltage":
{
"value": "$PHASE_VOLTAGE[1]$",
"alarm": "$PHASE_VOLTAGE_ALARM[1]$"
},
"current":
{
"value": "$PHASE_CURRENT[1]$",
"alarm": "$PHASE_CURRENT_ALARM[1]$"
},
"power":
{
"active":
{
"value": "$PHASE_POWER_ACTIVE[1]$",
"alarm": "$PHASE_POWER_ACTIVE_ALARM[1]$"
},
"reactive":
{
"value": "$PHASE_POWER_REACTIVE[1]$",
"alarm": "$PHASE_POWER_REACTIVE_ALARM[1]$"
},
"apparent":
{
"value": "$PHASE_POWER_APPARENT[1]$",
"alarm": "$PHASE_POWER_APPARENT_ALARM[1]$"
},
"factor":
{
"value": "$PHASE_POWER_FACTOR[1]$"
}
},
"frequency":
{
"value": "$PHASE_FREQUENCY[1]$",
"alarm": "$PHASE_FREQUENCY_ALARM[1]$"
},
"consumption":
{
"value": "$PHASE_CONSUMPTION[1]$"
},
"fuse":
{
"alarm": "$PHASE_FUSE_ALARM[1]$"
}
},
{
"name": "$PHASE_NAME[2]$",
"number": "$PHASE_NUMBER[2]$",
"voltage":
{
"value": "$PHASE_VOLTAGE[2]$",
"alarm": "$PHASE_VOLTAGE_ALARM[2]$"
},
"current":
{
"value": "$PHASE_CURRENT[2]$",
"alarm": "$PHASE_CURRENT_ALARM[2]$"
},
"power":
{
"active":
{
"value": "$PHASE_POWER_ACTIVE[2]$",
"alarm": "$PHASE_POWER_ACTIVE_ALARM[2]$"
},
"reactive":
{
"value": "$PHASE_POWER_REACTIVE[2]$",
"alarm": "$PHASE_POWER_REACTIVE_ALARM[2]$"
},
"apparent":
{
"value": "$PHASE_POWER_APPARENT[2]$",
"alarm": "$PHASE_POWER_APPARENT_ALARM[2]$"
},
"factor":
{
"value": "$PHASE_POWER_FACTOR[2]$"
}
},
"frequency":
{
"value": "$PHASE_FREQUENCY[2]$",
"alarm": "$PHASE_FREQUENCY_ALARM[2]$"
},
"consumption":
{
"value": "$PHASE_CONSUMPTION[2]$"
},
"fuse":
{
"alarm": "$PHASE_FUSE_ALARM[2]$"
}
},
{
"name": "$PHASE_NAME[3]$",
"number": "$PHASE_NUMBER[3]$",
"voltage":
{
"value": "$PHASE_VOLTAGE[3]$",
"alarm": "$PHASE_VOLTAGE_ALARM[3]$"
},
"current":
{
"value": "$PHASE_CURRENT[3]$",
"alarm": "$PHASE_CURRENT_ALARM[3]$"
},
"power":
{
"active":
{
"value": "$PHASE_POWER_ACTIVE[3]$",
"alarm": "$PHASE_POWER_ACTIVE_ALARM[3]$"
},
"reactive":
{
"value": "$PHASE_POWER_REACTIVE[3]$",
"alarm": "$PHASE_POWER_REACTIVE_ALARM[3]$"
},
"apparent":
{
"value": "$PHASE_POWER_APPARENT[3]$",
"alarm": "$PHASE_POWER_APPARENT_ALARM[3]$"
},
"factor":
{
"value": "$PHASE_POWER_FACTOR[3]$"
}
},
"frequency":
{
"value": "$PHASE_FREQUENCY[3]$",
"alarm": "$PHASE_FREQUENCY_ALARM[3]$"
},
"consumption":
{
"value": "$PHASE_CONSUMPTION[3]$"
},
"fuse":
{
"alarm": "$PHASE_FUSE_ALARM[3]$"
}
}
]
}
MultiSensor
Beispiel
{
"event_id": "$EVENT_ID$",
"ts": "$UNIXTIME$",
"time": "$TIME$",
"date": "$DATE$",
"temp_unit": "$TEMP_UNIT$",
"ambient_temperature": {
"value": "$AMBIENT_TEMP_VALUE$",
"alarm": "$AMBIENT_TEMP_ALARM$"
},
"humidity": {
"value": "$HUMIDITY_VALUE$",
"alarm": "$HUMIDITY_ALARM$"
},
"dewpoint": {
"value": "$DEWPOINT_VALUE$",
"alarm": "$DEWPOINT_ALARM$"
},
"fire_ti": {
"value": "$FIRE_TI_VALUE$",
"alarm": "$FIRE_TI_ALARM$"
},
"fire_co": {
"value": "$FIRE_CO_VALUE$",
"alarm": "$FIRE_CO_ALARM$"
},
"heat": {
"value": "$HEAT_VALUE$",
"alarm": "$HEAT_ALARM$"
},
"motion": {
"value": "$MOTION_VALUE$",
"alarm": "$MOTION_ALARM$"
},
"vibration": {
"alarm": "$VIBRATION_ALARM$"
},
"di1": {
"name": "$DI_NAME[1]$",
"value": "$DI_VALUE[1]$",
"alarm": "$DI_ALARM[1]$"
},
"di2": {
"name": "$DI_NAME[2]$",
"value": "$DI_VALUE[2]$",
"alarm": "$DI_ALARM[2]$"
}
}