Skip to main content

9 API

The firmware of the WCC Lite features a built-­in API which is accessible via the web interface. As of version 1.2.11, it does not implement any access restriction features apart from those provided by the firewall functionality.

Individual API endpoints can be enabled or disabled via the web configuration interface at Services­>API.

All endpoints are disabled by default. Available API endpoints are shown in the table below.

Path Description

Request body

(encoded as "multipart-form-data")

Response body example

(json format)

/api/version Version of the API
{
    "api_version": "2",
    "api_patch": "1",
    "sync_version": "lite1"
}
/api/actions  List of available points

/api/syncVersion Version of the sync service

/api/sync

Protocol hub configuration upload
(key name="file").

Returns excel-utility output )*

{
    "file""config.xlsx"
}

/api/syslog  Prints out the syslog

/api/systemInfo General system info

/api/gsmInfo  GSM modem information

/api/devices  List of configured devices

/api/device/info  Returns configured devices information.
(key name="device_alias")**
{
    "device_alias""INV1"
}
{
    "devices": [
        {
            "device_alias": "INV1",
            "name": "INV1",
            "protocol": "modbus rtu"
        }
    ]
}
/api/device/tags

List of tags of a particular configured device.

(key name="device_alias")**

{
    "device_alias": "INV1"
}

{
    "total_signals": "7",
    "signals": [
        {
            "signal_name": "Active power",
            "source_device_alias": "",
            "input_topic": "tag/INV1/P/rin",
            "output_topic": "tag/INV1/P/out",
            "signal_alias": "P"
        },

...

/api/device/tag/value

Returns tags value, name, timestamp, and flags of a particular device. 
(key name="device_alias",

key name="signal_alias")**

{
    "device_alias": "INV1",
    "signal_alias": "P"
}
{
    "total_signals": "1",
    "signal_values": [
        {
            "signal_name": "Active power",
            "value": "5.9589999999999996",
            "timestamp": "1708000203824",
            "flags": ""
        }
    ]
}
/api/tags  List of configured tags

/api/sysupgrade  Firmware upgrade. (key name="file")*

* Endpoints accepting files (requires WCC Lite Firmware version 1.8 or newer)
** Endpoints accepting field data (requires WCC Lite firmware version 1.8 or newer)

The API accepts data and files as POST requests encoded as ”multipart/form­data”.