HTTPS API

Version 1.1 by Wecon on 2025/09/03 21:04

Warning

Important Notice:

This standard defines Wecon's proprietary access protocol. Third-party API integration requires explicit authorization through our V-net V2.0 platform, with all API access strictly monitored and regulated. Wecon reserves all rights to interpret and modify these specifications without prior notice.

To prevent API abuse,this feature will not be enabled by default for all users. Access requires submitting an application, with a monthly free quota of 10,000 times.

1.Third-party account

On the V-NET 2.0 platform, API functions require integration with third-party accounts.

1.1 Create a third-party account

hj18xtdG0np.png

PixPin_2025-07-09_11-27-51.png

Information

Noted:After clicking "OK", the third-party account password will no longer be visible. Please back it up promptly.

1.2 Assign device to third-party account

1.choose the third-party account

bu3lT1iyiV.png

2.select a device to bind

v1U3oIZDMH.png

3.Binded successfully

1752032411880-592.png

2.Operational process

2.1 Basic information

  • Request url: https://api.asean.v-iec.com/m16/{acturl}

  • Protocol: https

  • Interface Parameter Description:

Global Parameters (HTTP Headers)

The following acturls need to have global parameters (The global parameter client is put into the JSON format and placed in the common parameters of the Headers)

ParameterDescription
sidsession ID (Obtained after login, and is used for all acturls after login)
tsMillisecond-level timestamp;( e.g. ,1750818494344)
sign

How to get sign:

Concatenate all parameters, including the header parameters above and the individual business parameters of each interface, in the format key=value, separated by & symbols. For example, for the login interface, the concatenated result would be:
alias=test&cuid=123456789&password=dc6e6a331dc2b23420d99c53a0d4962e&pid=1&sv=1.0&mt=255&ts=1595381946008&lan=zh&sign=sign

Here, alias and password are the business parameters specific to the login interface, while the others are header parameters (Note: The sid parameter is excluded for the login interface but must be included for other interfaces).

  1. Sort all parameters alphabetically:
    • Order by the first letter; if the first letters are identical, proceed to the second letter, and so on.
  2. Append the fixed parameter key=5cee621329f24e5cbdc43daa959ce9a1 at the end:
    • This parameter is mandatory for all interfaces and must always be placed last.

Finally, calculate the MD5 hash of the concatenated string to generate the sign

The final header parameters are as follows (Note: The login interface does not require 'sid', while other interfaces must include 'sid'. The value of 'ts' must be identical to the 'ts' used in the above sign calculation):

wcommon:{"dap":"","cuid":"123456789","sv":"1.0","mt":"255","lan":"zh","sign":"XXX","pid":"1","ts":1742612007058}

Return the result in JSON format, case-sensitive, for example:

1) Client error responses

{"code" : 403, "msg" : "session timeout", "reqId":"1502074141465", "result":{}}

2) Successful responses

{"code" : 200 , "result": {}, "msg" : "ok", "reqId":"1502074141465"}

HTTP response status codes

Status codesDescription
200The request succeeded
400Bad Request
403Forbidden (invalid Session ID)
503Bad Request

2.2 Recommended tools

1) Current Millis - Provides the current time in milliseconds elapsed since the UNIX epoch (Jan 1, 1970) as well as in other common formats including local / UTC time

1750850646536-560.png

2) MD5 Encryption - Online tool for generating MD5 hashes from strings

1750850693417-516.png

3.Third-party API invocation Method

Example parameter and value

alias:3af2a002690b4becbd3d4fbced0d2df3

password:87845c1edaa92c4b24b64b65bb5fd2bb

ts:1750818494344

3.1 Login operation

acturlwe-data/sign/login
FunctionUse username to login
ParametersItemsDescription
aliasUsername
password32-bit password (MD5 encryption)
isRemember0(Optional)
Return valueItemsDescription
utypeUser Type: 
sidUser session ID (Only available for 12 hours)
ztRole

Cloud SCADA permissions:

1 - Has permission, 0 - No permission

userNameuser name
Example

{

    "utype":5,

    "ztRole":1,

    "userName":"0edc4188a48f4bdcb7e89d35c6e7986f",

    "sid":"c253a6a9635646a98bb46fba22411568"

}

Operating procedures

Setp1:  Set URL: https://api.asean.v-iec.com/m16/we-data/sign/login

Setp2:  Set parameters on Params

 alias: 3af2a002690b4becbd3d4fbced0d2df3

 password: 9fa4250f6d70b341199f6dace528120f(The md5 encryption result of 87845c1edaa92c4b24b64b65bb5fd2bb)

1750852260814-901.png

Step3:  Get sign

alias=3af2a002690b4becbd3d4fbced0d2df3&cuid=123456789&lan=zh&mt=255&password=9fa4250f6d70b341199f6dace528120f&pid=1&sv=1.0&ts=1750818494344&key=5cee621329f24e5cbdc43daa959ce9a1

Put the whole string above encrypted by MD5, so will get the value of "sign"

"sign":"d3071131ae5c7ab032fca3c623101e89"

Step4:  Set wcommon of header

{"dap":"","cuid":"123456789","sv":"1.0","mt":"255","lan":"zh","sign":"d3071131ae5c7ab032fca3c623101e89","pid":"1","ts":1750818494344}

1750852478079-903.png

 Result

1750852594291-467.png

Now, we got the sid for other API invocation

3.2 Get the device list

acturlwe-data/device/getList
FunctionGet the device list
ParametersItemDescription
  
Return valueItemDescription
boxListDevices supporting WVPN
listDevice List
Example{
    "reqId": "1667285652454",
    "code": 200,
    "msg": "ok",
    "result": {
        "boxList": [
            {
                "code": "U370H1220307220W0001c75b693b2955",
                "lev_name": "Group",
                "name": "name1",
                "f_name": " Group ",
                "model": "PI3070ig",
                "boxType": 1,
                "id": 444860,
                "state": 1,
                "f_id": 226038,
                "type": "1",
                "lev_id": "226038",
                "create_date": 1653985793000
            },
            {
                "code": "V02001211222999a2d12c52a355",
                "lev_name": "Default group",
                "name": " V-BOX ",
                "f_name": "Default group",
                "model": "V-BOX S-4G",
                "boxType": 0,
                "id": 444848,
                "state": 0,
                "f_id": 225922,
                "type": "1",
                "lev_id": "225922",
                "create_date": 1652378606000
            }
        ],
        "list": [
            {
                "all": 3,
                "offline": 0,
                "lev_name": " group",
                "children": [
                    {
                        "all": 0,
                        "offline": 0,
                        "lev_name": " group 1, group ",
                        "children": [],
                        "name": " group 1",
                        "f_name": " group ",
                        "online": 0,
                        "id": 225986,
                        "f_id": 226038,
                        "type": "0",
                        "lev_id": "225986,226038",
                        "create_date": 1657010779000
                    },
                    {
                        "code": "U370H1220307220W0001c75b693b2955",
                        "lev_name": "group",
                        "name": "aaaaa",
                        "f_name": " group ",
                        "model": "PI3070ig",
                        "boxType": 1,
                        "id": 444860,
                        "state": 1,
                        "f_id": 226038,
                        "type": "1",
                        "lev_id": "226038",
                        "create_date": 1653985793000
                    }
                ],
                "name": "Group",
                "online": 3,
                "id": 226038,
                "f_id": 0,
                "type": "0",
                "lev_id": "226038",
                "create_date": 1659618529000
            },
            {
                "all": 1,
                "offline": 1,
                "lev_name": "Default group",
                "children": [
                    {
                        "all": 0,
                        "offline": 0,
                        "lev_name": "Test 2,Default group",
                        "children": [],
                        "name": " Test 2",
                        "f_name": "Default group",
                        "online": 0,
                        "id": 225987,
                        "f_id": 225922,
                        "type": "0",
                        "lev_id": "225987,225922",
                        "create_date": 1657010789000
                    },
                    {
                        "code": "V02001211222999a2d12c52a355",
                        "lev_name": "Default group",
                        "name": "V-BOX",
                        "f_name": "Default group",
                        "model": "V-BOX S-4G",
                        "boxType": 0,
                        "id": 444848,
                        "state": 0,
                        "f_id": 225922,
                        "type": "1",
                        "lev_id": "225922",
                        "create_date": 1652378606000
                    }
                ],
                "name": "Default group",
                "online": 0,
                "id": 225922,
                "f_id": 0,
                "type": "0",
                "lev_id": "225922",
                "create_date": 1653984617000
            }
        ]
    }
}

Operating procedures(Dome)

Step1:  Set URL:https://api.asean.v-iec.com/m16/we-data/device/getList

Step2:  Get sign (Using the sid obtained from calling the login API;demonstrated here as "e95ae840f7f147718d2b7650abe6c05f")

cuid=123456789&lan=zh&machineCode=V1400023040700790f5e19a1b55&mt=255&pid=1&sid=e95ae840f7f147718d2b7650abe6c05f&sv=1.0&ts=1750818494344&key=5cee621329f24e5cbdc43daa959ce9a1

Put the whole string above encrypted by MD5, so will get the value of "sign"  

"sign":"f0889257ce45e561959928ba5475fbf1"

Step4:  Set wcommon of header

{"dap":"","cuid":"123456789","sv":"1.0","mt":"255","lan":"zh","sign":"f0889257ce45e561959928ba5475fbf1","pid":"1","ts":1750818494344,"sid":"e95ae840f7f147718d2b7650abe6c05f"}

1750906712204-462.png

Result

1750924923320-272.png

3.3 Get device state

acturlwe-data/device/getDeviceState
FunctionGet device state
ParametersItemDescription
machineCodeMachine Code
Return valueItemDescription
state0:Offline 1: Online
Example{
    "code": 200,
    "msg": "ok",
    "result": {
        "state": 1 
    }
}

Operating procedures(Dome)

Step1:  Set URL:https://api.asean.v-iec.com/m16/we-data/device/getDeviceState

Step2: Set parameters on Params

"machineCode": "V1400023040700790f5e19a1b55"

1750925468847-205.png

Step3: Get sign

cuid=123456789&lan=zh&machineCode=V1400023040700790f5e19a1b55&mt=255&pid=1&sid=e95ae840f7f147718d2b7650abe6c05f&sv=1.0&ts=1750818494344&key=5cee621329f24e5cbdc43daa959ce9a1

Put the whole string above encrypted by MD5, so will get the value of "sign"  

"sign":"f0889257ce45e561959928ba5475fbf1"

Step4:  Set wcommon of header

{"dap":"","cuid":"123456789","sv":"1.0","mt":"255","lan":"zh","sign":"f0889257ce45e561959928ba5475fbf1","pid":"1","ts":1750818494344,"sid":"e95ae840f7f147718d2b7650abe6c05f"}

Result

1750925773973-469.png

3.4 Get real-time tag list

acturlwe-data/actGroup
FunctionGet real-time tag list
ParametersItemDescription
boxIdV-box ID
Return valueItemDescription
listGroup list
groupIdGroup Id
groupNameGroup Name
Example{
    "code": 200,
    "msg": "ok",
    "result": {
        "list": [
            {
                "groupId": 1,  
                "groupName": "group 1"   
            },
            {
                "groupId": 2,  
                "groupName": "group 2"  
            }
        ]
    }
}

Operating procedures(Dome)

Step1:  Set URL:https://api.asean.v-iec.com/m16/we-data/actGroup

Step2: Set parameters on Params

"boxId": "10108"

1750926881603-584.png

Step3: Get sign

boxId=10108&cuid=123456789&lan=zh&mt=255&pid=1&sid=e95ae840f7f147718d2b7650abe6c05f&sv=1.0&ts=1750818494344&key=5cee621329f24e5cbdc43daa959ce9a1

Put the whole string above encrypted by MD5, so will get the value of "sign"  

"sign":"9e933e16e03f2821a58aa9694de49969"

Step4:  Set wcommon of header

{"dap":"","cuid":"123456789","sv":"1.0","mt":"255","lan":"zh","sign":"9e933e16e03f2821a58aa9694de49969","pid":"1","ts":1750818494344,"sid":"e95ae840f7f147718d2b7650abe6c05f"}

1750926908151-938.png

Result

1750926982185-137.png

3.5 Get real-time tag configuration

acturl/we-data/realcfgs
FunctionGet real-time tag configuration
ParametersItemDescription
boxIdV-box ID (Required)
groupIdGroup ID (Required)
pageSizeNumber of items per page (defaults to 10 if not specified)
pageIndexPage number, starting from 1
devtype0: V-Box ,1: HMI (Required)
Return valueItemDescription
cfgListConfiguration list
monitorIdMonitor ID
monitorNameMonitor Name
updTimeLast Update Time
dataId

Data Type:

100 - 16-bit Binary

101 - 16-bit Octal

... (Refer to Appendix 1)

addrAddress
addrType

0:bit address

1:byte address

2:word address

3:double word

digitCountinteger digits, decimal digits
digitBinarycarry system
dataLimitData Range
ridRegister Address
roleType

Access Permission:

1 - Read Only

2 - Write Only

3 - Read/Write

totalPageTotal Pages
totalRecordTotal Records
currentPageCurrent Page
Example{
    "code":200,
    "msg":"ok",
    "reqId":"1595385125344",
    "result":
    {
        "cfgList":
        [
            {
                "monitorId":544225,
                "dataId":105,
                "monitorName":"00",
                "updTime":1589506814000,
                "dataLimit":"0 99999",
                "digitBinary":" decimal",
                "addr":"0",
                "rid":"0",
                "roleType":3,
                "digitCount":"",
                "addrType":0
            },
            {
                "monitorId":544224,
                "dataId":105,
                "monitorName":"40",
                "updTime":1589507516000,
                "dataLimit":"0 99999",
                "digitBinary":" decimal",
                "addr":"0",
                "rid":"4",
                "roleType":3,
                "digitCount":"5,
                0",
                "addrType":2
            }
        ],
        "totalPage":1,
        "totalRecord":2,
        "currentPage":1
    }
}

Operating procedures(Dome)

Step1:  Set URL:https://api.asean.v-iec.com/m16//we-data/realcfgs

Step2: Set parameters on Params

"boxId": "10108"

"groupId": "307096"

"devtype": "0"

1750930526412-753.png

Step3: Get sign

boxId=10108&cuid=123456789&devtype=0&groupId=307096&lan=zh&mt=255&pid=1&sid=e95ae840f7f147718d2b7650abe6c05f&sv=1.0&ts=1750818494344&key=5cee621329f24e5cbdc43daa959ce9a1

Put the whole string above encrypted by MD5, so will get the value of "sign"  

"sign":"60fafbd0d795036e2ae09b4053c65671"

Step4:  Set wcommon of header

{"dap":"","cuid":"123456789","sv":"1.0","mt":"255","lan":"zh","sign":"60fafbd0d795036e2ae09b4053c65671","pid":"1","ts":1750818494344,"sid":"e95ae840f7f147718d2b7650abe6c05f"}

1750930595350-219.png

Result

1750930627007-466.png

3.6 Get Real-time data list

acturlwe-data/realdata
FunctionGet Real-time data list
ParametersItemDescription
boxIdV-box ID (Required)
groupIdGroup ID (Required)
pageSizeThe number of each page, default 10
pageIndexPages, starting from 1
devtypeDevice type (0:box,1:hmi)  (Required)
Return valueItemDescription
listReal-time data list
comCom port ID
monitorIdMonitor ID
monitorNameMonitor Name
stateState
valueValue
groupIdGroup ID
totalPageTotal Pages
totalRecordTotal Records
currentPageCurrent Page
Example

{
    "code": 200,
    "msg": "ok",
    "result": {
        "list": [
            {
                "com": 1,  // com port ID
                "monitorId": 1,  //Monitor ID
                "monitorName": "plc1",  //Monitor Name
                "state": 1,  //State
                "value": 12,   //value
"groupId": 8// Group ID

            },
            {
                "com": 2,  //com port ID
                "monitorId": 2,  
                "monitorName": "plc2",
                "state": 1,
                "value": 13,
"groupId": 8//Group ID
            }
        ],
totalPage:10,
totalRecord:500,
currentPage:2
    }
}

Operating procedures(Dome)

Step1:  Set URL:https://api.asean.v-iec.com/m16/we-data/realdata

Step2: Set parameters on Params

"boxId": "10108"

"groupId": "307096"

"devtype": "0"

1750931496306-864.png

Step3: Get sign

boxId=10108&cuid=123456789&devtype=0&groupId=307096&lan=zh&mt=255&pid=1&sid=1750818494344&sv=1.0&ts=1750818494344&key=5cee621329f24e5cbdc43daa959ce9a1

Put the whole string above encrypted by MD5, so will get the value of "sign"  

"sign":"aa65f3d58da6dff1da04dc2f9babd931"

Step4:  Set wcommon of header

{"dap":"","cuid":"123456789","sv":"1.0","mt":"255","lan":"zh","sign":"aa65f3d58da6dff1da04dc2f9babd931","pid":"1","ts":1750818494344,"sid":"e95ae840f7f147718d2b7650abe6c05f"}

1750931571632-223.png

Result

1750931696007-370.png

3.7 Modify the data of real-time tag

acturlwe-data/updrealdata
FunctionModify the data of real-time tag
ParametersItemDescription
boxIdV-box ID (Required)
monitorIdMonitor ID
valuevalue
devtypeDevice type (0:box,1:hmi)  (Required)
Return valueItemDescription
  
Example{
    "code":200
    "msg":"ok",        
    "result":{
    } 
}

Operating procedures(Dome)

Step1:  Set URL:https://api.asean.v-iec.com/m16/we-data/updrealdata

Step2: Set parameters on Params

"boxId": "10108"

"monitorId": "10002423"

"value": "33"

"devtype": "0"

1750932160187-949.png

Step3: Get sign

boxId=10108&cuid=123456789&devtype=0&lan=zh&monitorId=10002423&mt=255&pid=1&sid=e95ae840f7f147718d2b7650abe6c05f&sv=1.0&ts=1750818494344&value=33&key=5cee621329f24e5cbdc43daa959ce9a1

Put the whole string above encrypted by MD5, so will get the value of "sign"  

"sign":"d8cd8c57e3220c8327be1895ed2b3ca8"

Step4:  Set wcommon of header

{"dap":"","cuid":"123456789","sv":"1.0","mt":"255","lan":"zh","sign":"d8cd8c57e3220c8327be1895ed2b3ca8","pid":"1","ts":1750818494344,"sid":"e95ae840f7f147718d2b7650abe6c05f"}

1750932298989-982.png

Result

1750932371164-131.png

3.8 Get Historical tags name list

acturlwe-data/monitors
FunctionGet a list of historical tags
ParametersItemDescription
boxIdV-box ID (Required)
devtypeDevice type (0:box,1:hmi)  (Required)
Return valueItemDescription
listTag list
monitorIdMonitor ID
monitorNameMonitor Name
groupIdGroup ID
Example{
    "code": 200,
    "msg": "ok",
    "result": {
        "list": [
            {
                "monitorId": 1,  
                "monitorName": "tag 1"
                "groupId": "00000001" 
            },
            {
                "monitorId": 2,  
                "monitorName": "tag 2"  
"groupId": "00000002"  
            }
        ]
    }
}

Operating procedures(Dome)

Step1:  Set URL:https://api.asean.v-iec.com/m16/we-data/monitors

Step2: Set parameters on Params

"boxId": "10108"

"devtype": "0"

1750937987348-940.png

Step3: Get sign

boxId=10108&cuid=123456789&devtype=0&lan=zh&mt=255&pid=1&sid=e95ae840f7f147718d2b7650abe6c05f&sv=1.0&ts=1750818494344&key=5cee621329f24e5cbdc43daa959ce9a1

Put the whole string above encrypted by MD5, so will get the value of "sign"  

"sign":"066fd57475cbb808e1c095205b334e6e"

Step4:  Set wcommon of header

{"dap":"","cuid":"123456789","sv":"1.0","mt":"255","lan":"zh","sign":"066fd57475cbb808e1c095205b334e6e","pid":"1","ts":1750818494344,"sid":"e95ae840f7f147718d2b7650abe6c05f"}

1750938105712-443.png

 Result

1750938200648-249.png

3.9 Get Historical tag data list

acturlwe-data/historydata
FunctionGet historical data
ParametersItemDescription
boxIdV-box ID (Required)
monitorIdtag ID, (Required)
groupIdGroup ID
monitorBeginTimeMonitoring start time, (Not required)
monitorEndTimeMonitoring end time, (Not required)
pageSizeNumber of each page, 10 by default
pageIndexNumber of current page, start from 1
Return valueItemDescription
listHistorical data list
monitorNameTag Name
monitorTimeMonitoring Time (timestamp)
monitorTime_showMonitoring time (formatted string)
valueValue
groupNameGroup Name
groupIdGroup ID
totalPageTotal Pages
totalRecordTotal Records
currentPageCurrent Page
Example{
    "code": 200,
    "msg": "ok",
    "result": {
        "list": [
            {
                "monitorName": "plc1",  //Monitor Name
                "value": 12, //value
                "monitorTime": "15645122555",  //monitoring time
                "monitorTime_show": "2017-05-25 12:18:30",  //monitoring time
"groupName": "", // group name
"groupId": 1 // group ID
            },
            {
                "monitorName": "plc2",
                "value": 13,
                "monitorTime": "2017-05-25 12:18:30"
"monitorTime_show": "2017-05-25 12:18:30",  //monitoring time
"groupName": "", // group name
"groupId": 1 //group ID
            }
        ],
totalPage:10,
totalRecord:500,
currentPage:2
    }
}

Operating procedures(Dome)

Step1:  Set URL:https://api.asean.v-iec.com/m16/we-data/historydata

Step2: Set parameters on Params

"boxId": "10108"

"groupId": "10000683"

"monitorId": "10002467"

1751251214664-153.png

Step3: Get sign

boxId=10108&cuid=123456789&groupId=10000683&lan=zh&monitorId=10002467&mt=255&pid=1&sid=e95ae840f7f147718d2b7650abe6c05f&sv=1.0&ts=1750818494344&key=5cee621329f24e5cbdc43daa959ce9a1

Put the whole string above encrypted by MD5, so will get the value of "sign"  

"sign":"6aabcd106be192898ac8cdc683a27bdf"

Step4:  Set wcommon of header

{"dap":"","cuid":"123456789","sv":"1.0","mt":"255","lan":"zh","sign":"6aabcd106be192898ac8cdc683a27bdf","pid":"1","ts":1750818494344,"sid":"e95ae840f7f147718d2b7650abe6c05f"}

1751251262825-117.png

 Result

1751251300796-556.png

3.10 Get Alarm tags data list

acturlwe-data/alarmdata
FunctionGet alarm data
ParametersItemDescription
boxIdV-box ID (Required)
monitorBeginTimeMonitoring start time, (Not required)
monitorEndTimeMonitoring end time, (Not required)
pageSizeNumber of each page, 10 by default
pageIndexNumber of current page, start from 1
stateStatus 1-unconfirmed, 2-confirm
alarmTypeAlarm events: 1-trigger alarm, 0-disarm
 alarmLevel

Alarm level:

1 general alarm,2 serious alarm,3 particularly serious alarm

 devtype0: V-Box ,1: HMI (Required)
Return valueItemDescription
listAlarm data list
monitorIdMonitor ID
monitorNameMonitor Name
stateState
valueValue
monitorTimeMonitoring time ( timestamp )
monitorTime_showMonitoring time (formatted string)
alarmTypeAlarm Type
alarmLevelAlarm Level
textAlarm content
alarm_roleAlarm permissions
totalPageTotal Pages
totalRecordTotal Records
currentPageCurrent Page
Example{
    "code": 200,
    "msg": "ok",
    "result": {
        "list": [
            {
"monitorId": 1,
                "monitorName": "plc1", 
                "state": 1, 
                "value": 12, 
                "monitorTime": "15215452111", 
"monitorTime_show": "2017-05-25 12:18:30",   
"alarmType": "", 
"alarmLevel": "",
"text": "",
"alarm_role": ""  
            },
            {
"monitorId": 1,  
                "monitorName": "plc2",
                "state": 1,
                "value": 13,
                "monitorTime": "621554211225",
"monitorTime_show": "2017-05-25 12:18:30",  
"alarmType": "", 
"alarmLevel": "",  
"text": "",  
"alarm_role": "" 
            }
        ],
totalPage:10,
totalRecord:500,
currentPage:2
    }
}

Operating procedures(Dome)

Step1:  Set URL:https://api.asean.v-iec.com/m16/we-data/alarmdata

Step2: Set parameters on Params

"boxId": "10108"

"state": "2"

"devtype": "0"

1751590830927-952.png

Step3: Get sign

boxId=10108&cuid=123456789&devtype=0&lan=zh&mt=255&pid=1&sid=e95ae840f7f147718d2b7650abe6c05f&state=2&sv=1.0&ts=1750818494344&key=5cee621329f24e5cbdc43daa959ce9a1

Put the whole string above encrypted by MD5, so will get the value of "sign"  

"sign":"d689e54257984a9804bc0822df97d1a8"

Step4:  Set wcommon of header

{"dap":"","cuid":"123456789","sv":"1.0","mt":"255","lan":"zh","sign":"d689e54257984a9804bc0822df97d1a8","pid":"1","ts":1750818494344,"sid":"e95ae840f7f147718d2b7650abe6c05f"}

1751590858077-283.png

Result

1751590880404-167.png

3.11 Notify the device to report real-time data

acturlwe-data/sendSwitchToDevice
FunctionNotify the device to report real-time data. Since the device now has a real-time data toggle feature, it will only report real-time data when on the real-time data page. Otherwise, it will not report. Therefore, to continuously obtain real-time data, you must first call this interface and then invoke it every 20 seconds to ensure the device keeps reporting real-time data.
ParametersItemDescription
boxIdV-box ID (Required,supports batch operations with comma-separated values (maximum 5,000 box IDs per request), e.g., 3012,4021,5036)
Example{
    "code": 200,
    "msg": "ok",
    "result": {}
}

Operating procedures(Dome)

Step1:  Set URL:https://api.asean.v-iec.com//m16/we-data/sendSwitchToDevice

Step2: Set parameters on Params

"boxId": "10108"

1751590928746-181.png

Step3: Get sign

boxId=10108&cuid=123456789&groupId=10000683&lan=zh&monitorId=10002467&mt=255&pid=1&sid=e95ae840f7f147718d2b7650abe6c05f&sv=1.0&ts=1750818494344&key=5cee621329f24e5cbdc43daa959ce9a1

Put the whole string above encrypted by MD5, so will get the value of "sign"  

"sign":"9e933e16e03f2821a58aa9694de49969"

Step4:  Set wcommon of header

{"dap":"","cuid":"123456789","sv":"1.0","mt":"255","lan":"zh","sign":"9e933e16e03f2821a58aa9694de49969","pid":"1","ts":1750818494344,"sid":"e95ae840f7f147718d2b7650abe6c05f"}

1751590956278-632.png

Result

1751590971071-144.png

3.12 Confirm the alarm data (V-Box/HMI)

acturlwe-data/historydata   --  (V-BOX)
we-data/hmiDataAction/confirmData  --  (HMI)
FunctionConfirm the alarm data (V-BOX / HMI)
ParametersItemDescription
alarm_cfg_idsAlarm confirmation ID (Required)
monitor_timesMonitor time  (Required)
deviceIdDevice ID (Required)
alarm_types (HMI only)Alarm Type:1: Triggered, 0: Cancelled
Example{
    "code": 200,
    "msg": "ok",
    "reqId": "1663749297007",
    "result": {}
}

Operating procedures(Dome for V-BOX)

Step1:  Set URL:https://api.asean.v-iec.com/m16/we-data/alarmDataAction/confirmData

Step2: Set parameters on Params

"alarm_cfg_ids": "10000017"

"deviceId": "10108"

"monitor_times": "1748588490783"

1751592962453-264.png

Step3: Get sign

alarm_cfg_ids=10000017&cuid=123456789&deviceId=10108&lan=zh&monitor_times=1748588490783&mt=255&pid=1&sid=e95ae840f7f147718d2b7650abe6c05f&sv=1.0&ts=1750818494344&key=5cee621329f24e5cbdc43daa959ce9a1

Put the whole string above encrypted by MD5, so will get the value of "sign"  

"sign":"93e7cd5abe03040b16e645d2869706f2"

Step4:  Set wcommon of header

{"dap":"","cuid":"123456789","sv":"1.0","mt":"255","lan":"zh","sign":"93e7cd5abe03040b16e645d2869706f2","pid":"1","ts":1750818494344,"sid":"e95ae840f7f147718d2b7650abe6c05f"}

1751593015952-261.png

Result

1751593034158-244.png

3.12 Get remote monitoring Url

acturlwe-data/getMonitorUrl
FunctionGet remote monitoring Url
ParametersItemDescription
deviceIdDevice ID (Required)
Return valuef_verVersion
UrlRemote monitoring URL
Example{
    "code": 200,
    "msg": "ok",
    "reqId": "1663749297007",
    "result": {“f_ver”:”V_0.5”,“url”:http://245646468...52.hmi.we-con.com.cn:1142/index.html?d=115...&token=42354...}
}

Operating procedures(Dome)

Step1:  Set URL:https://api.asean.v-iec.com/m16/we-data/getMonitorUrl

Step2: Set parameters on Params

"deviceId": "10000467"

1751593657691-677.png

Step3: Get sign

cuid=123456789&deviceId=10000467&lan=zh&mt=255&pid=1&sid=e95ae840f7f147718d2b7650abe6c05f&sv=1.0&ts=1750818494344&key=5cee621329f24e5cbdc43daa959ce9a1

Put the whole string above encrypted by MD5, so will get the value of "sign"  

"sign":"dd1324f34dc90683373504f31aaf24cf"

Step4:  Set wcommon of header

{"dap":"","cuid":"123456789","sv":"1.0","mt":"255","lan":"zh","sign":"dd1324f34dc90683373504f31aaf24cf","pid":"1","ts":1750818494344,"sid":"e95ae840f7f147718d2b7650abe6c05f"}

1751594984300-563.png

Result

1751595028434-214.png