*Plugin – HTTP Server v2
Configuration Article | CA-20251223-MH-02 VDG Sense | Setup | Plugins | HTTP Server | |
This article applies to Sense versions 2.7.6 and higher.
For Sense versions 2.7.5 and lower please refer to this article: Plugin - HTTP Server
The HTTP Server plugin is the Sense system gateway between the Nginx webserver component and the SensePluginManager-service. It is needed to enable access via Sense API. Also the Sense Webclient and the iOS / Android apps rely on this plugin to work properly.
IMPORTANT: From Sense 2.7.6 and higher the use of HTTP has been deprecated. External access (API, Webclient and iOS / Android apps) is only possible via secure HTTPS connection using hardcoded port 443.
Until further notice the Android mobile app does not support HTTPS and therefor is not usable icw Sense 2.7.6 or higher. Android mobile app can only be used with Sense 2.7.5 or lower.
Configuration
The HTTP Server plugin can be found in the ‘Plugins’ tab. Because it is an essential part of the VDG Sense system it cannot be deactivated.
General
The ‘General’ tab holds the main settings of the HTTP Server plugin.
Setting | Value | Description | Default |
|---|---|---|---|
Address | <IP address> | Sense management server (master) IP address. When used with Redundant API it should be changed. | 127.0.0.1 |
Port | <port number> | TCP port (listening) used to accept connections. In case this port is already in use by some other service it can be easily changed. See following article: Change port | 8080 |
MaxConnections | <number> | Max. number of simultaneous TCP connections the plugin allows. | 64 |
ConnectionTimeout | <timeout> | Timeout (seconds) to close a connection when there is no activity. A value of ‘0’ means, never close connection. | 30 |
AbsoluteTimeout | <timeout> | Max. time (seconds) a session will be kept alive regardless of whether it is active or not. I.e. it will always be closed after this time. | 14400 |
MaxMultiPartCount | <number> | Set to 10 to reduce SensePluginManager memory load in combination with FlinQ. Only on request by TKH Support this should be changed. | 2147483647 |
SessionSetupTimeout | <timeout> | Max. time (in milliseconds) it may take to setup session. It might be needed to increase this value in case of having issues with API access in large systems. | 15000 |
SessionTimeout | <timeout> | Max. time (seconds) a session may be unused before it gets closed. Keep alive mechanism. I.e. if there is no activity within this timeout the session will be closed. This setting only applies when UsePersistentCookies is enabled. | 120 |
UsePersistentCookies | <boolean> | If enabled the SessionTimeout setting will be used as the max. time the session may be unused before it gets closed. | disabled |
Logging
The log level can be selected here. Normally all options are disabled. Only during issues and on request by TKH Support this should be changed.
Advanced
Setting | Value | Description | Default |
|---|---|---|---|
SkipLicenseTimeout | <timeout> | This parameter is icw the API call ‘getLicensePlate‘. It is the max. wait time (milliseconds) the API call will wait for a license plate(s) to get scanned. If no plate(s) is scanned within this time the API call returns with empty result. | 1000 |
Enable cookie only sessionkey | <boolean> | Enabled by default and prevents the use of the session key as parameter in API commands. Due to security reasons it is recommend to enable this. | enabled |
APIAlwaysUseLatestVersion | <boolean> | Commands are processed using latest API version. Only on request by TKH Support this should be changed. | true |
Add MAC address | <boolean> | This parameter is used icw API call ‘getDivaList’. If enabled the <macaddress>-field will be added to the result. On multi-NIC servers this call could be slow and could interfere with Third-Party integrator operations. In most cases mac-address information is not required by integrators. | false |
APIVersion | <version> | Here the API version used can be selected. Only on request by TKH Support this should be changed. | 2.7.5 |
Transcoding
This menu holds transcoding settings for image requests via the API.
Setting | Value | Description | Default |
|---|---|---|---|
TranscodingEnabled | <boolean> | When enabled, Sense will transcode all images that are requested via the API. When disabled, by default the resolution of the image will be the same as the input resolution of the camera. But if an image request (e.g. getLiveImage) is done with <imagewidth> or <imageheight> specified, the image will be transcoded to the specified resolution. | disabled |
TranscodingQuality | <percentage> | Setting (percentage) to adjust the quality of the transcoded image. | 100 |
ImageWidth | <number> | Width (pixels) of the transcoded image. | 640 |
ImageHeight | <number> | Height (pixels) of the transcoded image. | 480 |
Access Control
These are advanced settings to control the HTTP headers of API calls. Only on request by TKH Support these should be changed.