Access
- The client must provide a valid apikey bound to a single Conclima customer group
- Your API Key (apikey) is provided on demand to Conclima
- The owner will provide the apikey to the supplier using APIs and can invalidate it at any time
- Access is allowed only over HTTPS (secure socket) using TLS 1.2
Calling APIs
Endpoint: https://xlink.conclima.it/api
Charset: UTF-8
Authentication/Authorization: Header X-Apikey or "apikey" in JSON body request
Data type: JSON (if necessary)
Methods:
- GET (
curl -H"X-Apikey: secret" https://xlink.conclima.it/api) - Raw POST of JSON (
curl -d @request.json https://xlink.conclima.it/api) - POST with www-form-encoded (as for a web-form submit) posting JSON in variable named "data" (
curl -F data='{"apikey":"secret"}' https://xlink.conclima.it/api/group/list) - POST JSON file as web-form file upload (
curl -F data=@request.json https://xlink.conclima.it/api)
- apikey secret (If not set in X-Apikey header)
plantList List of plants
Request
URI: /api/plant/list
{ "apikey": "secret" }
Response
{
"plants": [
{
"plantid": "19164067",
"name": "Sesto Fiorentino",
"city": "Osmannoro",
"province": "FI"
},
{
"plantid": "53120400",
"name": "Treviso (Silea)",
"city": "Silea",
"province": "TV"
},
{
"plantid": "53124009",
"name": "Lainate Sempione",
"city": "Lainate",
"province": "MI"
}
]
}
energyData Energy Data
Request
Optional arguments:- id
- Plant ID
- date
- Date to retrieve (yyyy-mm-dd)
- time
- Retrieve after time (hh:mm)
URI: /api/energydata
{ "apikey": "secret", }
Response
{
"energydata": [
{
"id": 18172152,
"g": 1,
"t": "2021-03-22 16:00:00",
"kwh": 429364.688,
"kw": 2.623,
"et": 20
},
{
"id": 18172152,
"g": 2,
"t": "2021-03-22 16:00:00",
"kwh": 55673.535,
"kw": 0.098,
"et": 20,
"error": 19
},
{
"id": 18172152,
"g": 3,
"t": "2021-03-22 16:00:00",
"kwh": 60876.898,
"et": 0.724,
"et": 20
}
]
}
Note:
- error #19 → "Communication Error occurred"
- error #25 → "Timeout occurred when a request was sent without receiving a corresponding response within the allowed time"
- error #38 → "Invalid data"
- error #62 → "Automatic interpolation on error #25"
- Request → (
/energydata?id=178&time=15:30) - Response:
{
"error": "plant '178' not available"
}
temperature Plants Temperatures
Request
Optional arguments:- id
- Plant ID
- date
- Date to retrieve (yyyy-mm-dd)
- time
- Retrieve after time (hh:mm)
URI: /api/temperature
{ "apikey": "secret", }
Response
{
"temperature": [
{
"id": 18172152,
"t": "2021-03-22 16:00",
"it": 20.2
},
{
"id": 18172152,
"t": "2021-03-22 16:00",
"it": 20.2
},
{
"id": 18172152,
"t": "2021-03-22 16:00",
"it": 20.2
}
]
}
Note:
- it=Internal temperature
groupList List of multimeters
Request
URI: /api/group/list
{ "apikey": "secret", }
Response
{
"groups": {
"1": "General",
"2": "Lights",
"3": "Wiring Power",
"4": "HVAC",
"5": "Kitchen Wiring Power",
"6": "Refrigeration",
"7": "General Secondary",
"10": "Photovoltaic"
}
}
