# 9 API

The firmware of the WCC Lite features a built-­in API which is accessible via the web interface.

The API (as of version 1.2.0) implements API key authorization, that is generated on the first boot of the device. The authorization can be enabled or disabled and the API key can be changed via the web configuration interface at Services → API.

##### Authentication

API key authentication is enabled by default and it generates a random 12-character long key. The key is stored in the same uci configuration as API.

To change the API key via the interface, it must be equal to or longer than 12 characters.

When API authentication is enabled WCC Lite+ checks if the "apiKey" header exists in the request and then validates its value against the one in the configuration. If the value is correct it continues with the API request, if the apiKey is incorrect or doesn't exist it returns an error response 401 with the message.

{

<div id="bkmrk-%C2%A0%C2%A0%C2%A0%C2%A0%22error%22%3A%C2%A0%22unauth"><div><span class="legacy-color-text-default"> </span><span data-colorid="v23cxtwknn">"error"</span><span class="legacy-color-text-default">: </span><span data-colorid="ysruyfohy4">"Unauthorized access."</span></div><div><span class="legacy-color-text-default">}</span></div><div>  
</div></div><div class="pointer-container" id="bkmrk-%C2%A0"><div class="pointer anim is-page-editable"><svg class="svg-icon" data-icon="link" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg><div class="input-group inline block"><input id="bkmrk-" placeholder="url" readonly="readonly" type="text"></input> <button class="button outline icon" data-clipboard-target="#pointer-url" title="Copy Link" type="button"><svg class="svg-icon" data-icon="copy" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></button></div><svg class="svg-icon" data-icon="edit" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg></div></div>Individual API endpoints can be enabled or disabled via the web configuration interface at Services-&gt;API.

All endpoints are disabled by default.

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

<table border="1" id="bkmrk-path-description-%2Fap" style="border-collapse: collapse; width: 106.173%; height: 567.031px;"><tbody><tr style="height: 80.0994px;"><td style="width: 18.6629%; height: 80.0994px;">Path</td><td style="width: 27.3146%; height: 80.0994px;">Description</td><td style="width: 20.148%; height: 80.0994px;">Request body

(encoded as "multipart-form-data")

</td><td style="width: 33.8632%; height: 80.0994px;">Response body example

(json format)

</td></tr><tr style="height: 29.7017px;"><td style="width: 18.6629%; height: 29.7017px;">/api/version</td><td style="width: 27.3146%; height: 29.7017px;">Version of the API</td><td style="width: 20.148%; height: 29.7017px;">  
</td><td style="width: 33.8632%; height: 29.7017px;">{  
 "api\_version": "2",  
 "api\_patch": "1",  
 "sync\_version": "lite1"  
}</td></tr><tr style="height: 29.7017px;"><td style="width: 18.6629%; height: 29.7017px;">/api/actions </td><td style="width: 27.3146%; height: 29.7017px;">List of available points</td><td style="width: 20.148%; height: 29.7017px;">  
</td><td style="width: 33.8632%; height: 29.7017px;">  
</td></tr><tr style="height: 29.7017px;"><td style="width: 18.6629%; height: 29.7017px;">/api/syncVersion</td><td style="width: 27.3146%; height: 29.7017px;">A version of the sync service</td><td style="width: 20.148%; height: 29.7017px;">  
</td><td style="width: 33.8632%; height: 29.7017px;">  
</td></tr><tr style="height: 80.0994px;"><td style="width: 18.6629%; height: 80.0994px;">/api/sync</td><td style="width: 27.3146%; height: 80.0994px;">Protocol hub configuration upload  
(key name="file").

Returns excel-utility output )\*

</td><td style="width: 20.148%; height: 80.0994px;"><div><span class="legacy-color-text-default">{</span></div><div><span class="legacy-color-text-default"> </span><span data-colorid="ko1fxaolvq">"file"</span><span class="legacy-color-text-default">: </span><span data-colorid="pjmlwkiiid">"config.xlsx"</span></div><div><span class="legacy-color-text-default">}</span></div></td><td style="width: 33.8632%; height: 80.0994px;">  
</td></tr><tr style="height: 29.7017px;"><td style="width: 18.6629%; height: 29.7017px;">/api/syslog </td><td style="width: 27.3146%; height: 29.7017px;">Prints out the syslog</td><td style="width: 20.148%; height: 29.7017px;">  
</td><td style="width: 33.8632%; height: 29.7017px;">  
</td></tr><tr style="height: 29.7017px;"><td style="width: 18.6629%; height: 29.7017px;">/api/systemInfo</td><td style="width: 27.3146%; height: 29.7017px;">General system info</td><td style="width: 20.148%; height: 29.7017px;">  
</td><td style="width: 33.8632%; height: 29.7017px;">  
</td></tr><tr style="height: 29.7017px;"><td style="width: 18.6629%; height: 29.7017px;">/api/gsmInfo </td><td style="width: 27.3146%; height: 29.7017px;">GSM modem information</td><td style="width: 20.148%; height: 29.7017px;">  
</td><td style="width: 33.8632%; height: 29.7017px;">  
</td></tr><tr style="height: 29.7017px;"><td style="width: 18.6629%; height: 29.7017px;">/api/devices </td><td style="width: 27.3146%; height: 29.7017px;">List of configured devices</td><td style="width: 20.148%; height: 29.7017px;">  
</td><td style="width: 33.8632%; height: 29.7017px;">  
</td></tr><tr style="height: 46.5057px;"><td style="width: 18.6629%; height: 46.5057px;">/api/device/info </td><td style="width: 27.3146%; height: 46.5057px;">Returns configured device information.  
(key name="device\_alias")\*\*</td><td style="width: 20.148%; height: 46.5057px;"><div><span class="legacy-color-text-default">{</span></div><div><span class="legacy-color-text-default"> </span><span data-colorid="tecnjgtiur">"device\_alias"</span><span class="legacy-color-text-default">: </span><span data-colorid="zqp7m8lka7">"INV1"</span></div><div><span class="legacy-color-text-default">}</span></div></td><td style="width: 33.8632%; height: 46.5057px;">{  
 "Devices": \[  
 {  
 "device\_alias": "INV1",  
 "name": "INV1",  
 "protocol": "modbus rtu"  
 }  
 \]  
}</td></tr><tr style="height: 46.5057px;"><td style="width: 18.6629%; height: 46.5057px;">/api/device/tags</td><td style="width: 27.3146%; height: 46.5057px;">List of tags of a particular configured device.

(key name="device\_alias")\*\*

</td><td style="width: 20.148%; height: 46.5057px;"><div>{  
 "device_alias": "INV1"  
}</div></td><td style="width: 33.8632%; height: 46.5057px;">{  
 "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"  
 },

...

</td></tr><tr style="height: 46.5057px;"><td style="width: 18.6629%; height: 46.5057px;">/api/device/tag/value</td><td style="width: 27.3146%; height: 46.5057px;">Returns tags value, name, timestamp, and flags of a particular device.   
(key name="device\_alias",

key name="signal\_alias")\*\*

</td><td style="width: 20.148%; height: 46.5057px;">{  
 "device\_alias": "INV1",  
 "signal\_alias": "P"  
}</td><td style="width: 33.8632%; height: 46.5057px;">{  
 "total\_signals": "1",  
 "signal\_values": \[  
 {  
 "signal\_name": "Active power",  
 "value": "5.9589999999999996",  
 "timestamp": "1708000203824",  
 "flags": ""  
 }  
 \]  
}</td></tr><tr style="height: 29.7017px;"><td style="width: 18.6629%; height: 29.7017px;">/api/tags </td><td style="width: 27.3146%; height: 29.7017px;">List of configured tags</td><td style="width: 20.148%; height: 29.7017px;">  
</td><td style="width: 33.8632%; height: 29.7017px;">  
</td></tr><tr style="height: 29.7017px;"><td style="width: 18.6629%; height: 29.7017px;">/api/sysupgrade </td><td style="width: 27.3146%; height: 29.7017px;">Firmware upgrade. (key name="file")\*</td><td style="width: 20.148%; height: 29.7017px;">{  
 "file": "1.8.0-rtu.sysupgrade"  
}</td><td style="width: 33.8632%; height: 29.7017px;">If successfully started the upgrade:

{  
 "message": "Upgrade started"  
}  
If failed to begin:  
{  
 "message": "Failed to begin upgrade"  
}  
If firmware validation failed:  
{  
 "message": "Failed to validate image"  
}

</td></tr></tbody></table>

\* 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”.

If API authorization is enabled, you must add a header "apiKey" with the correct key.