Skip to Content

Wiki source code of 07 HTTP API

Version 28.1 by Devin Chen on 2025/06/30 14:09
Show last authors
1 = **General** =
2
3 This documents introduces WECON V-BOX HTTP API. And this document also shows some examples. All example is tested from postman application.
4
5 **Transport protocol:** HTTP protocol
6
7 **Server address:**
8
9 China:
10
11 [[http:~~/~~/api.v-box.net>>url:http://api.v-box.net/]]
12
13 Asean:
14
15 [[http:~~/~~/api.asean.v-box.net>>url:http://api.v-box.net/]]
16
17 Europe:
18
19 [[http:~~/~~/api.eu.v-box.net>>url:http://api.v-box.net/]]
20
21 (% style="text-align:center" %)
22 [[image:V-BOX HTTP manual_html_ceb1e13ef4c1fa5d.png||height="361" width="800" class="img-thumbnail"]]
23
24 For **ASEAN server** V-BOX, now can use http, the server address is api.asean.v-box.net.
25
26 The common KEY is:
27
28 **comid=128**
29
30 **comkey=7e421dd30a394d74b7b9c079e67e272c**
31
32 screctkey=f1cd9351930d4e589922edbcf3b09a7c
33
34 {{id name="_GoBack"/}}
35
36 For** EU server **V-BOX, now can use http, the server address is api.eu.v-box.net.
37
38 The common KEY is:
39
40 **comid=100**
41
42 **comkey=8919244ff15d441bae4b944b112a33ea**
43
44 screctkey=f1cd9351930d4e589922edbcf3b09a7c
45
46 (% class="box infomessage" %)
47 (((
48 **✎Note:** If it is for Virtual Deployment, the comid and comkey would not be the same with values above. Try to get the actual value from HTTP access (V-NET~-~-Services~-~-HTTP access)
49 )))
50
51 == **Interface Parameter Description** ==
52
53 **Global parameters**
54
55 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)
56
57 (% style="text-align:center" %)
58 [[image:企业微信截图_20210531172144.png||height="467" width="800" class="img-thumbnail"]]
59
60 **The returned result represented by Json and case sensitive:**
61
62 1).Abnormal
63
64 {"code" : 403, "msg" : "SessionID (user session ID) invalid", "reqId": "1502074141465"}
65
66 2).Normal
67
68 {"code" : 200 , "result": {}, "msg" : "ok", "reqId":"1502074141465"}
69
70 **Status Code**
71
72 (% style="text-align:center" %)
73 [[image:1.png||height="141" width="500" class="img-thumbnail"]]
74
75 == **Example key and value** ==
76
77 1).**comid**=2
78
79 2).**comkey**=589625dce895454dbff9782c299db156
80
81 3).**screctkey**=f1cd9351930d4e589922edbcf3b09a7c
82
83 4).**ts**=1573897380
84
85 (((
86 = **Basic API** =
87 )))
88
89 == **{{id name="_Toc24963726"/}}Login operation** ==
90
91 (((
92 **2.1.1 Parameters**
93 )))
94
95 (% class="table-bordered" style="width:888px" %)
96 |**Acturl**|(% colspan="2" style="width:731px" %)we-data/login
97 |**Function**|(% colspan="2" style="width:731px" %)Login with username, email, phone number
98 |(% colspan="1" rowspan="4" %)**Parameters**|Items|(% style="width:535px" %)Description
99 |alias|(% style="width:535px" %)Must be username, registered email will fail to login
100 |password|(% style="width:535px" %)32bit password (MD5 encryption)
101 |domain(Optional)|(% style="width:535px" %)3rd party interface domain(Only available for Virtual Deployment)
102 |(% rowspan="3" %)**Return value**|Items|(% style="width:535px" %)Description
103 |utype|(% style="width:535px" %)User Type: 1-Manage Account, 2-Viewer Account
104 |sid|(% style="width:535px" %)User session ID (Only available for 12 hours)
105
106 **Operating procedures**
107
108 **Setp1: ** Set http: [[http:~~/~~/api.v-box.net/box-data/api/we-data/login>>url:http://api.v-box.net/box-data/api/we-data/login]]
109
110 (% style="text-align:center" %)
111 [[image:V-BOX HTTP manual_html_78fa6b0e5f03b2f2.png||height="63" width="800" class="img-thumbnail"]]
112
113 **Setp2: ** Set parameters on Params
114
115 alias: weconuser
116
117 password: 599a3c736c04e196c58a29f43778f7ea(The md5 encryption result of Wecon159)
118
119 (% style="text-align:center" %)
120 [[image:V-BOX HTTP manual_html_563261d83c8f3530.png||height="250" width="700" class="img-thumbnail"]]
121
122 **Step3:**  Get sign
123
124 alias=weconuser&comid=2&compvtkey=589625dce895454dbff9782c299db156&password=599a3c736c04e196c58a29f43778f7ea&ts=1573897380&key=f1cd9351930d4e589922edbcf3b09a7c
125
126 Put the whole string above encrypted by MD5, so will get the value of "sign"
127
128 "sign":"997513ff1320862f0cbb9ce19d0bd253"
129
130 {{info}}
131 **✎Note: **For Virtual Deployment, the sign string should be append with domain, so the format would be like following:
132
133 alias=xxx&comid=xxx&compvtkey=xxx&domain=xxx&password=xxx&ts=1657682972386&key=f1cd9351930d4e589922edbcf3b09a7c
134
135 The timestamp must be unit as Millisecond level
136 {{/info}}
137
138 **Step4: ** Set common of header
139
140 {"comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"997513ff1320862f0cbb9ce19d0bd253"}
141
142 (% style="text-align:center" %)
143 [[image:V-BOX HTTP manual_html_cbfc9bbb7d0d4f84.png||height="230" width="700" class="img-thumbnail"]]
144
145 (((
146 **Result**
147 )))
148
149 {
150
151 "code": 200,
152
153 "msg": "ok",
154
155 "reqId": "1573899119000",
156
157 "result": {
158
159 "utype": 1,
160
161 "ztRole": 1,
162
163 "sid": "2d7bfd344aa64d8ebc9beea0e4dad8ad"
164
165 }
166
167 }
168
169 (% style="text-align:center" %)
170 [[image:V-BOX HTTP manual_html_b00e7e6a00828e27.png||height="291" width="500" class="img-thumbnail"]]
171
172 (((
173 = **Service data APIs** =
174 )))
175
176 == **V-Box list** ==
177
178 **{{id name="_Toc24963732"/}}Parameters**
179
180 (% style="text-align:center" %)
181 [[image:X.png||height="412" width="700" class="img-thumbnail"]]
182
183 **~ {{id name="_Toc24963733"/}}Operating procedures**
184
185 **Step1:**  Set http: [[http:~~/~~/api.v-box.net/box-data/api/we-data/boxs>>url:http://api.v-box.net/box-data/api/we-data/boxs]]
186
187 (% style="text-align:center" %)
188 [[image:V-BOX HTTP manual_html_7555868f6d398292.png||height="48" width="700" class="img-thumbnail"]]
189
190 **Step2:**  Set parameters on Params
191
192 No parameters for this acturl, so no need to set.
193
194 **Step3: ** Get sign
195
196 comid=2&compvtkey=589625dce895454dbff9782c299db156&sid=2d7bfd344aa64d8ebc9beea0e4dad8ad&ts=1573897380&key=f1cd9351930d4e589922edbcf3b09a7c
197
198 MD5 value: 8fb4fbf99fcc1331c3274e708a403034
199
200 **Step4:**  Set common of header
201
202 {"sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"8fb4fbf99fcc1331c3274e708a403034"}
203
204 (% style="text-align:center" %)
205 [[image:V-BOX HTTP manual_html_999832f3a31ac851.png||height="232" width="700" class="img-thumbnail"]]
206
207 **Result**
208
209 {
210
211 "code": 200,
212
213 "msg": "ok",
214
215 "reqId": "1573900361203",
216
217 "result": {
218
219 "list": [
220
221 {
222
223 "groupName": "",
224
225 "boxList": [
226
227 {
228
229 "machineCode": "V01001171116005027a279eb001",
230
231 "devModel": "V-BOX S-00",
232
233 "isAlarm": 0,
234
235 "boxName": "Treatment Systems",
236
237 "remark": "",
238
239 "state": "1",
240
241 "map": "78.178613,9.177124",
242
243 "boxId": "913"
244
245 },
246
247 …………
248
249 {
250
251 "machineCode": "Vir001171116005027a27201908",
252
253 "devModel": "V-BOX S-00",
254
255 "isAlarm": 0,
256
257 "boxName": "(Smart farm)",
258
259 "remark": "",
260
261 "state": "1",
262
263 "map": "88.637476,50.415074",
264
265 "boxId": "973"
266
267 }
268
269 ]
270
271 },
272
273 ……………………
274
275 {
276
277 "groupName": "(Manufacturing)",
278
279 "boxList": [
280
281 {
282
283 "machineCode": "Vir001171116005027a27201904",
284
285 "devModel": "V-BOX S-00",
286
287 "isAlarm": 0,
288
289 "boxName": "(Adjustment)",
290
291 "remark": "",
292
293 "state": "1",
294
295 "map": "109.316038,33.749868",
296
297 "boxId": "957"
298
299 },
300
301 ………………
302
303 {
304
305 "machineCode": "Vir001171116005027a27201915",
306
307 "devModel": "V-BOX S-00",
308
309 "isAlarm": 0,
310
311 "boxName": "",
312
313 "remark": "",
314
315 "state": "1",
316
317 "map": "121.357068,24.312132",
318
319 "boxId": "975"
320
321 }
322
323 ]
324
325 }
326
327 ]
328
329 }
330
331 }
332
333 (% style="text-align:center" %)
334 [[image:V-BOX HTTP manual_html_5999b14ed63e8065.png||height="348" width="600" class="img-thumbnail"]]
335
336 == **Real-time group list** ==
337
338 **{{id name="_Toc24963736"/}} Parameters**
339
340 (% class="table-bordered" %)
341 |**acturl**|(% colspan="3" %)we-data/realgroups
342 |**Functions**|(% colspan="3" %)Get V-BOX’s tags group list
343 |(% rowspan="2" %)**Parameters**|Parameter|(% colspan="2" %)Description
344 |boxId|(% colspan="2" %)VBoxID ("None" means custom grouping)
345 |(% rowspan="4" %)**Return value**|Field name|(% colspan="2" %)Description
346 |(% rowspan="3" %)list|(% colspan="2" %)Group list
347 |groupId|Group ID
348 |groupName|Group name
349
350 **Operating procedures**
351
352 **Step1: **Set http: [[http:~~/~~/api.v-box.net/box-data/api/we-data/realgroups>>url:http://api.v-box.net/box-data/api/we-data/realgroups]]
353
354 (% style="text-align:center" %)
355 [[image:V-BOX HTTP manual_html_abb2159981171c6.png||height="46" width="700" class="img-thumbnail"]]
356
357 **Step2: **Set parameters on Params
358
359 "boxId": "973"
360
361 (% style="text-align:center" %)
362 [[image:V-BOX HTTP manual_html_5c3ab35ebdab144e.png||height="151" width="800" class="img-thumbnail"]]
363
364 **Step3: **Get sign
365
366 boxId=973&comid=2&compvtkey=589625dce895454dbff9782c299db156&sid=2d7bfd344aa64d8ebc9beea0e4dad8ad&ts=1573897380&key=f1cd9351930d4e589922edbcf3b09a7c
367
368 MD5 value: 9b267b7549083167954b7ede30916ff5
369
370 **Step4: **Set common of header
371
372 {"boxId":"973","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"9b267b7549083167954b7ede30916ff5"}
373
374 (% style="text-align:center" %)
375 [[image:V-BOX HTTP manual_html_cc06cac462c1b77a.png||height="172" width="800" class="img-thumbnail"]]
376
377 **Result**
378
379 {
380
381 "code": 200,
382
383 "msg": "ok",
384
385 "reqId": "1573901906667",
386
387 "result": {
388
389 "list": [
390
391 {
392
393 "groupName": "Temperature",
394
395 "groupId": 7325
396
397 },
398
399 {
400
401 "groupName": "Humidity",
402
403 "groupId": 7326
404
405 },
406
407 {
408
409 "groupName": "Button switch",
410
411 "groupId": 7327
412
413 }
414
415 ]
416
417 }
418
419 }
420
421 [[image:V-BOX HTTP manual_html_2445c358293d621.png||height="531" width="532"]]
422
423 == **Real-time tags configuration list** ==
424
425 **Parameters**
426
427 (% class="table-bordered" %)
428 |**acturl**|(% colspan="3" %)we-data/realcfgs
429 |**Functions**|(% colspan="3" %)Get the tags configuration information in the specified group in V-BOX.
430 |(% colspan="1" rowspan="6" %)**Parameters**|Parameter|(% colspan="2" %)Description
431 |boxId|(% colspan="2" %)VBoxID(“None” means custom tags grouping)
432 |groupId|(% colspan="2" %)Group ID (Required)
433 |pageSize|(% colspan="2" %)Number of each page, 10 by default
434 |pageIndex|(% colspan="2" %)Number of current page, start from 1
435 |devType|(% colspan="2" %)Device type (0:Box, 1:HMI)
436 |(% rowspan="15" %)**Return value**|Field name|(% colspan="2" %)Description
437 |(% rowspan="11" %)cfgList|monitorId|Tags ID
438 |monitorName|Tags name
439 |updTime|Last update time
440 |dataId|(((
441 type of data
442
443 100: 16-bit binary
444
445 101: 16-digit octal
446
447 Refer to Appendix 1
448 )))
449 |addr|Address
450 |addrType|(((
451 0: bit address
452
453 1: byte address
454
455 2: word address
456
457 3: double word
458 )))
459 |digitCount|Integer digits, decimal places
460 |digitBinary|Data type and integer digits, decimal places
461 |dataLimit|Data range
462 |rid|Address
463 |roleType|Permission: 1-read only, 2-write only, 3-read-write
464 |totalPage|(% colspan="2" %)Total pages
465 |totalRecord|(% colspan="2" %)Total record number
466 |currentPage|(% colspan="2" %)Current page number
467
468 **Operating procedures**
469
470 **Step1: **Set http: [[http:~~/~~/api.v-box.net/box-data/api/we-data/realcfgs>>url:http://api.v-box.net/box-data/api/we-data/realcfgs]]
471
472 (% style="text-align:center" %)
473 [[image:V-BOX HTTP manual_html_3fff373ae27e2e00.png||height="44" width="700" class="img-thumbnail"]]
474
475 **Step2: **Set parameters on Params
476
477 "boxId":"973"
478
479 "groupId":"7325"
480
481 "devType":"0"
482
483 "pageSize":"5"
484
485 "pageIndex":"2"
486
487 (% style="text-align:center" %)
488 [[image:1751263596452-675.png||height="222" width="555"]]
489
490 **Step3:** Get sign
491
492 boxId=763&comid=128&compvtkey=7e421dd30a394d74b7b9c079e67e272c&devType=0&groupId=211608&pageIndex=1&pageSize=5&sid=0e583b1f48cf467bbf738365b3da1a26&ts=1751263335125&key=f1cd9351930d4e589922edbcf3b09a7c
493
494 MD5 sign: 27a89c93a4990d0497a8bd47dea4aed3
495
496 **Step4:** Set common of header
497
498 {"compvtkey":"7e421dd30a394d74b7b9c079e67e272c","sign":"27a89c93a4990d0497a8bd47dea4aed3","comid":"128","sid":"0e583b1f48cf467bbf738365b3da1a26","ts":1751263335125}
499
500 (% style="text-align:center" %)
501 [[image:1751263680622-643.png]]
502
503 **Result**
504
505 {
506
507 "code": 200,
508
509 "msg": "ok",
510
511 "reqId": "1751263500705",
512
513 "result": {
514
515 "cfgList": [
516
517 {
518
519 "monitorId": 2276374,
520
521 "monitorName": "x0",
522
523 "digitBinary": "",
524
525 "float_point": -1,
526
527 "rid": "X",
528
529 "roleType": 1,
530
531 "string_point": -1,
532
533 "dataId": 105,
534
535 "addr_stat_no": -1,
536
537 "updTime": 1745481123000,
538
539 "dataLimit": "0 1",
540
541 "addr": "0",
542
543 "digitCount": "",
544
545 "boxId": 763,
546
547 "addrType": 0
548
549 },
550
551 {
552
553 "monitorId": 2276373,
554
555 "monitorName": "y0",
556
557 "digitBinary": "",
558
559 "float_point": -1,
560
561 "rid": "Y",
562
563 "roleType": 3,
564
565 "string_point": -1,
566
567 "dataId": 105,
568
569 "addr_stat_no": -1,
570
571 "updTime": 1745480354000,
572
573 "dataLimit": "0 1",
574
575 "addr": "0",
576
577 "digitCount": "",
578
579 "boxId": 763,
580
581 "addrType": 0
582
583 },
584
585 {
586
587 "monitorId": 2276367,
588
589 "monitorName": "okg",
590
591 "digitBinary": "",
592
593 "float_point": 1,
594
595 "rid": "HDW",
596
597 "roleType": 3,
598
599 "string_point": -1,
600
601 "dataId": 105,
602
603 "addr_stat_no": -1,
604
605 "updTime": 1745475213000,
606
607 "dataLimit": "0 299999",
608
609 "addr": "10",
610
611 "digitCount": "5,0",
612
613 "boxId": 763,
614
615 "addrType": 2
616
617 },
618
619 {
620
621 "monitorId": 2276366,
622
623 "monitorName": "hjdfh",
624
625 "digitBinary": "",
626
627 "float_point": -1,
628
629 "rid": "HDX",
630
631 "roleType": 3,
632
633 "string_point": -1,
634
635 "dataId": 105,
636
637 "addr_stat_no": -1,
638
639 "updTime": 1745475139000,
640
641 "dataLimit": "0 299999,0 15",
642
643 "addr": "0,0",
644
645 "digitCount": "",
646
647 "boxId": 763,
648
649 "addrType": 0
650
651 }
652
653 ],
654
655 "totalPage": 1,
656
657 "totalRecord": 4,
658
659 "currentPage": 1
660
661 }
662
663 }
664
665 (% style="text-align:center" %)
666 [[image:1751263773173-191.png]]
667
668 == **Tags data list** ==
669
670 {{warning}}
671 This API is not for getting the real-time data all the time.If you need to get the continuously updated real-time monitoring point data values,you need to use **[[Send switch to device>>https://docs.we-con.com.cn/bin/view/V-BOX/V-Net/Manual/6%20HTTP%20API/#HSendswitchtodevice]] **API with this API
672 {{/warning}}
673
674 **~ {{id name="_Toc24963744"/}}Parameters**
675
676 (% class="table-bordered" %)
677 |**acturl**|(% colspan="3" %)we-data/realdata
678 |**Functions**|(% colspan="3" %)Get the tags data in the specified group in V-BOX.
679 |(% colspan="1" rowspan="6" %)**Parameters**|Parameter|(% colspan="2" %)Description
680 |boxId|(% colspan="2" %)VBoxID(“None” means custom tag grouping)
681 |groupId|(% colspan="2" %)Group ID (Required)
682 |pageSize|(% colspan="2" %)Number of each page, 10 by default
683 |pageIndex|(% colspan="2" %)Number of current page, start from 1
684 |devType|(% colspan="2" %)Device type (0:Box, 1:HMI)
685 |(% rowspan="11" %)**Return value**|Field name|(% colspan="2" %)Description
686 |(% rowspan="7" %)List|(% colspan="2" %)Real-time data list
687 |com|Communication port ID
688 |monitorId|Tag ID
689 |monitorName|Tag name
690 |state|status
691 |value|Value
692 |groupId|Group ID
693 |totalPage|(% colspan="2" %)Total pages
694 |totalRecord|(% colspan="2" %)Total record
695 |currentPage|(% colspan="2" %)current page
696
697 **~ {{id name="_Toc24963745"/}}Operating procedures**
698
699 **Step1: **Set http: [[http:~~/~~/api.v-box.net/box-data/api/we-data/realdata>>url:http://api.v-box.net/box-data/api/we-data/realdata]]
700
701 (% style="text-align:center" %)
702 [[image:V-BOX HTTP manual_html_839fb0577dac88c1.png||height="45" width="700" class="img-thumbnail"]]
703
704 **Step2: **Set parameters on Params
705
706 "boxId":"973"
707
708 "groupId":"7325"
709
710 "pageSize":"5"
711
712 "pageIndex":"2"
713
714 (% style="text-align:center" %)
715 [[image:V-BOX HTTP manual_html_b860bab44ebbc128.png||height="272" width="700" class="img-thumbnail"]]
716
717 **Step3:** Get sign
718
719 boxId=973&comid=2&compvtkey=589625dce895454dbff9782c299db156&groupId=7325&pageIndex=2&pageSize=5&sid=2d7bfd344aa64d8ebc9beea0e4dad8ad&ts=1573897380&key=f1cd9351930d4e589922edbcf3b09a7c
720
721 MD5 sign: 0769228e66c945eed5431c41a96949f2
722
723 {"boxId":"973","groupId":"7325","pageSize":"5","pageIndex":"2","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"0769228e66c945eed5431c41a96949f2"}
724
725 **~ {{id name="_Toc24963746"/}}Result**
726
727 {
728
729 "code": 200,
730
731 "msg": "ok",
732
733 "reqId": "1573905679365",
734
735 "result": {
736
737 "totalPage": 3,
738
739 "list": [
740
741 {
742
743 "com": 2939,
744
745 "monitorId": 91545,
746
747 "monitorName": "Temp_9",
748
749 "groupId": 0,
750
751 "state": "1",
752
753 "value": "90"
754
755 },
756
757 …………
758
759 },
760
761 {
762
763 "com": 2939,
764
765 "monitorId": 91541,
766
767 "monitorName": "Temp_5",
768
769 "groupId": 0,
770
771 "state": "1",
772
773 "value": "87"
774
775 }
776
777 ],
778
779 "totalRecord": 15,
780
781 "currentPage": 2
782
783 }
784
785 }
786
787 (% style="text-align:center" %)
788 [[image:V-BOX HTTP manual_html_705682e81eae5ea7.png||height="651" width="800" class="img-thumbnail"]]
789
790 == **Modify tag data** ==
791
792 (((
793 **Parameters**
794 )))
795
796 (% class="table-bordered" %)
797 |**acturl**|(% colspan="2" %)we-data/updrealdata
798 |**Functions**|(% colspan="2" %)Modify tag data
799 |(% rowspan="5" %)**Parameters**|Parameter|Description
800 |boxId|Box ID
801 |monitorId|Tag ID
802 |value|value
803 |devType|Device type (0:Box, 1:HMI)
804 |**Return value**|(% colspan="2" %)None
805
806 **Operating procedures**
807
808 **Step1:** Set http: [[http:~~/~~/api.v-box.net/box-data/api/we-data/updrealdata>>url:http://api.v-box.net/box-data/api/we-data/updrealdata]]
809
810 (% style="text-align:center" %)
811 [[image:1651915094120-525.png||height="45" width="700" class="img-thumbnail"]]
812
813 **Step2:** Set parameters on Params
814
815 boxId:6397578
816 monitorId:1001
817 value:66
818 devType:1
819
820 (% style="text-align:center" %)
821 [[image:1746502882467-849.png]]
822
823 **Step3:** Get sign
824
825 boxId=6397578&comid=128&compvtkey=7e421dd30a394d74b7b9c079e67e272c&devType=1&monitorId=1001&sid=d8c98edd64da40289fef565c94924fe5&ts=171746501715435&value=66&key=f1cd9351930d4e589922edbcf3b09a7c
826
827 MD5 sign: 4802a362fde2ca5053ad79fe4d272200
828
829 **Step4: **Set common of header
830
831 {"compvtkey":"7e421dd30a394d74b7b9c079e67e272c","sign":"4802a362fde2ca5053ad79fe4d272200","comid":"128","sid":"d8c98edd64da40289fef565c94924fe5","ts":171746501715435}
832
833 (% style="text-align:center" %)
834 [[image:1746503047845-902.png]]
835
836 **Result**
837
838 {
839
840 "code": 200,
841
842 "msg": "ok",
843
844 "reqId": "1573907138803",
845
846 "result": {}
847
848 }
849
850 (% style="text-align:center" %)
851 [[image:1746503002289-932.png]]
852
853 == **Historical tags name list** ==
854
855 **Parameters**
856
857 (% class="table-bordered" %)
858 |**acturl**|(% colspan="3" %)we-data/monitors
859 |**Functions**|(% colspan="3" %)Get a list of historical tags
860 |(% rowspan="3" %)**Parameters**|Parameter|(% colspan="2" %)Description
861 |boxId|(% colspan="2" %)Box ID (Not required)
862 |devType|(% colspan="2" %)Device type (0:Box, 1:HMI)
863 |(% rowspan="4" %)**Return value**|Field name|(% colspan="2" %)Description
864 |(% rowspan="3" %)list|(% colspan="2" %)Tag list
865 |monitorId|tag ID
866 |monitorName|tag name
867
868 **Operating procedures**
869
870 **Step1: **Set http: [[http:~~/~~/api.v-box.net/box-data/api/we-data/monitors>>url:http://api.v-box.net/box-data/api/we-data/monitors]]
871
872 (% style="text-align:center" %)
873 [[image:V-BOX HTTP manual_html_456f00c6af3ea1b7.png||height="45" width="700" class="img-thumbnail"]]
874
875 **Step2: **Set parameters on Params
876
877 "boxId":"973"
878
879 (% style="text-align:center" %)
880 [[image:V-BOX HTTP manual_html_8bf7c3f9b3ce3897.png||height="185" width="700" class="img-thumbnail"]]
881
882 **Step3:** Get sign
883
884 boxId=973&comid=2&compvtkey=589625dce895454dbff9782c299db156&sid=2d7bfd344aa64d8ebc9beea0e4dad8ad&ts=1573897380&key=f1cd9351930d4e589922edbcf3b09a7c
885
886 MD5 sign: 9b267b7549083167954b7ede30916ff5
887
888 **Step4:** Set common of header
889
890 {"boxId":"973","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"9b267b7549083167954b7ede30916ff5"}
891
892 (% style="text-align:center" %)
893 [[image:V-BOX HTTP manual_html_dba52ac718eeb66e.png||height="228" width="700" class="img-thumbnail"]]
894
895 **Result**
896
897 {
898
899 "code": 200,
900
901 "msg": "ok",
902
903 "reqId": "1573907813693",
904
905 "result": {
906
907 "list": [
908
909 {
910
911 "monitorId": 91576,
912
913 "monitorName": "Hum",
914
915 "groupId": 7328
916
917 },
918
919 {
920
921 "monitorId": 91577,
922
923 "monitorName": "Temp",
924
925 "groupId": 7328
926
927 }
928
929 ]
930
931 }
932
933 }
934
935 (% style="text-align:center" %)
936 [[image:V-BOX HTTP manual_html_2a739377a9fb10b2.png||height="400" width="700" class="img-thumbnail"]]
937
938 == **Historical tag data list** ==
939
940 **~ {{id name="_Toc24963756"/}}Parameters**
941
942 (% class="table-bordered" %)
943 |**acturl**|(% colspan="3" %)we-data/historydata
944 |**Functions**|(% colspan="3" %)Get historical data
945 |(% rowspan="6" %)**Parameters**|Parameter|(% colspan="2" %)Description
946 |monitorId|(% colspan="2" %)tag ID, (Required)
947 |monitorBeginTime|(% colspan="2" %)Monitoring start time, (Not required)
948 |monitorEndTime|(% colspan="2" %)Monitoring end time, (Not required)
949 |pageSize|(% colspan="2" %)Number of each page, 10 by default
950 |pageIndex|(% colspan="2" %)Number of current page, start from 1
951 |(% rowspan="8" %)**Return value**|Field name|(% colspan="2" %)Description
952 |(% rowspan="4" %)list|(% colspan="2" %)Historical data list
953 |monitorName|tag name
954 |monitorTime|Monitoring time
955 |value|Value
956 |totalPage|(% colspan="2" %)Total pages
957 |totalRecord|(% colspan="2" %)Total records
958 |currentPage|(% colspan="2" %)Current page
959
960 **Operating procedures**
961
962 **Step:** Set http: [[http:~~/~~/api.v-box.net/box-data/api/we-data/historydata>>url:http://api.v-box.net/box-data/api/we-data/historydata]]
963
964 (% style="text-align:center" %)
965 [[image:V-BOX HTTP manual_html_cd2fdea1493dc20e.png||height="47" width="700" class="img-thumbnail"]]
966
967 **Step2:** Set parameters on Params
968
969 "monitorId": 91577
970
971 "monitorBeginTime":"2019-11-16 10:45:44.000"
972
973 "monitorEndTime":"2019-11-16 20:45:44.000"
974
975 "pageSize":"10"
976
977 "pageIndex":"2"
978
979 (% style="text-align:center" %)
980 [[image:V-BOX HTTP manual_html_f169ff87c20ce6c4.png||height="302" width="700" class="img-thumbnail"]]
981
982 **Step3: **Get sign
983
984 comid=2&compvtkey=589625dce895454dbff9782c299db156&monitorBeginTime=2019-11-16 10:45:44.000&monitorEndTime=2019-11-16 20:45:44.000&monitorId=91577&pageIndex=2&pageSize=10&sid=2d7bfd344aa64d8ebc9beea0e4dad8ad&ts=1573897380&key=f1cd9351930d4e589922edbcf3b09a7c
985
986 MD5 sign: feeae8ddb4014951cfc2c02de4744bc4
987
988 **Step4:** Set common of header
989
990 {"monitorId":"91577","monitorBeginTime":"2019-11-16 10:45:44.000","monitorEndTime":"2019-11-16 20:45:44.000","pageSize":"10","pageIndex":"2","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"feeae8ddb4014951cfc2c02de4744bc4"}
991
992 (% style="text-align:center" %)
993 [[image:V-BOX HTTP manual_html_fac48b1179b555ee.png||height="291" width="700" class="img-thumbnail"]]
994
995 **Result**
996
997 {
998
999 "code": 200,
1000
1001 "msg": "ok",
1002
1003 "reqId": "1573909705772",
1004
1005 "result": {
1006
1007 "totalPage": 12,
1008
1009 "list": [
1010
1011 {
1012
1013 "monitorTime": 1573905337000,
1014
1015 "groupName": "His",
1016
1017 "monitorTime_show": "2019-11-16 19:55:37.000",
1018
1019 "monitorName": "Temp",
1020
1021 "groupId": 7328,
1022
1023 "value": "914"
1024
1025 },
1026
1027 ……………
1028
1029 {
1030
1031 "monitorTime": 1573902637000,
1032
1033 "groupName": "His",
1034
1035 "monitorTime_show": "2019-11-16 19:10:37.000",
1036
1037 "monitorName": "Temp",
1038
1039 "groupId": 7328,
1040
1041 "value": "422"
1042
1043 }
1044
1045 ],
1046
1047 "totalRecord": 120,
1048
1049 "currentPage": 2
1050
1051 }
1052
1053 }
1054
1055 (% style="text-align:center" %)
1056 [[image:V-BOX HTTP manual_html_f3b62eb69687a214.png||height="476" width="700" class="img-thumbnail"]]
1057
1058 == **Alarm tags data list** ==
1059
1060 **{{id name="_Toc24963760"/}}Parameters**
1061
1062 (% class="table-bordered" %)
1063 |**acturl**|(% colspan="3" %)we-data/alarmdata
1064 |**Function**|(% colspan="3" %)Get alarm data
1065 |(% rowspan="10" %)**Parameters**|Parameter|(% colspan="2" %)Description
1066 |boxId|(% colspan="2" %)VBoxID, (Required)
1067 |monitorBeginTime|(% colspan="2" %)Monitoring start time, (Not required)
1068 |monitorEndTime|(% colspan="2" %)Monitoring end time, (Not required)
1069 |pageSize|(% colspan="2" %)Number of each page, 10 by default
1070 |pageIndex|(% colspan="2" %)Number of current page, start from 1
1071 |state|(% colspan="2" %)Status 1-unconfirmed, 2-confirm
1072 |alarmType|(% colspan="2" %)Alarm events: 1-trigger alarm, 0-disarm (Not necessary)
1073 |alarmLevel|(% colspan="2" %)(((
1074 Alarm level: 1 general alarm,
1075
1076 2 serious alarm,
1077
1078 3 particularly serious alarm
1079
1080 (Not necessary)
1081 )))
1082 |devType|(% colspan="2" %)Device type (0:Box, 1:HMI)
1083 |(% rowspan="12" %)**Return value**|Field name|(% colspan="2" %)Description
1084 |(% rowspan="8" %)List|(% colspan="2" %)Alarm data list
1085 |monitorId|tag ID
1086 |monitorName|tag name
1087 |state|status
1088 |value|Value
1089 |monitorTime|Monitoring time
1090 |alarmType|Alarm event
1091 |alarmLevel|Alarm level
1092 |totalPage|(% colspan="2" %)Total pages
1093 |totalRecord|(% colspan="2" %)Total records
1094 |currentPage|(% colspan="2" %)Current page
1095
1096 **~ {{id name="_Toc24963761"/}}Operating procedures**
1097
1098 **Step1:** Set http: [[http:~~/~~/api.v-box.net/box-data/api/we-data/alarmdata>>url:http://api.v-box.net/box-data/api/we-data/alarmdata]]
1099
1100 (% style="text-align:center" %)
1101 [[image:V-BOX HTTP manual_html_4ebee4d4fcf0097c.png||height="45" width="700" class="img-thumbnail"]]
1102
1103 **Step2:** Set parameters on Params
1104
1105 "monitorId":"91931"
1106
1107 "monitorBeginTime":"2019-11-16 20:30:44.000"
1108
1109 "monitorEndTime":"2019-11-16 21:30:44.000"
1110
1111 "pageSize":"10"
1112
1113 "pageIndex":"1"
1114
1115 "state":"2"
1116
1117 (% style="text-align:center" %)
1118 [[image:V-BOX HTTP manual_html_2361d0eaa7447a9c.png||height="327" width="700" class="img-thumbnail"]]
1119
1120 **Step3:** Get sign
1121
1122 comid=2&compvtkey=589625dce895454dbff9782c299db156&monitorBeginTime=2019-11-16 20:30:44.000&monitorEndTime=2019-11-16 21:30:44.000&monitorId=91931&pageIndex=1&pageSize=10&sid=2d7bfd344aa64d8ebc9beea0e4dad8ad&state=2&ts=1573897380&key=f1cd9351930d4e589922edbcf3b09a7c
1123
1124 MD5 sign: 4056006bbc71bd80a3c632987626e15b
1125
1126 **Step4: **Set common of header
1127
1128 {"monitorId":"91931","monitorBeginTime":"2019-11-16 20:30:44.000","monitorEndTime":"2019-11-16 21:30:44.000","pageSize":"10","pageIndex":"1","state":"2","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"4056006bbc71bd80a3c632987626e15b"}
1129
1130 (% style="text-align:center" %)
1131 [[image:V-BOX HTTP manual_html_cd9ce84648b86cb9.png||height="269" width="700" class="img-thumbnail"]]
1132
1133 **Result**
1134
1135 {
1136
1137 "code": 200,
1138
1139 "msg": "ok",
1140
1141 "reqId": "1573911745258",
1142
1143 "result": {
1144
1145 "totalPage": 1,
1146
1147 "list": [
1148
1149 {
1150
1151 "monitorTime": 1573910934000,
1152
1153 "alarmType": 0,
1154
1155 "monitorId": 4437,
1156
1157 "monitorTime_show": "2019-11-16 21:28:54",
1158
1159 "monitorName": "Temperature alarm",
1160
1161 "alarmLevel": 2,
1162
1163 "state": 2,
1164
1165 "text": "The temperature is too high",
1166
1167 "value": "1",
1168
1169 "alarm_role": 0
1170
1171 },
1172
1173 …………
1174
1175 {
1176
1177 "monitorTime": 1573910855000,
1178
1179 "alarmType": 1,
1180
1181 "monitorId": 4437,
1182
1183 "monitorTime_show": "2019-11-16 21:27:35",
1184
1185 "monitorName": "Temperature alarm",
1186
1187 "alarmLevel": 2,
1188
1189 "state": 2,
1190
1191 "text": "The temperature is too high",
1192
1193 "value": "18",
1194
1195 "alarm_role": 0
1196
1197 }
1198
1199 ],
1200
1201 "totalRecord": 6,
1202
1203 "currentPage": 1
1204
1205 }
1206
1207 }
1208
1209 (% style="text-align:center" %)
1210 [[image:V-BOX HTTP manual_html_d4a3e0114c402c27.png||height="475" width="700" class="img-thumbnail"]]
1211
1212 == **Get device state** ==
1213
1214 **~ {{id name="_Toc24963760"/}}Parameters**
1215
1216 (% class="table-bordered" %)
1217 |**acturl**|(% colspan="3" %)we-data/getDeviceState
1218 |**Function**|(% colspan="3" %)Get vbox state based on machine code
1219 |(% colspan="1" rowspan="2" %)**Parameters**|Parameter|(% colspan="2" %)Description
1220 |machineCode|(% colspan="2" %)machineCode(required)
1221 |(% rowspan="2" %)**Return value**|Field name|(% colspan="2" %)Description
1222 |state|(% colspan="2" %)vbox state: 1-online,  0-offline
1223
1224 == **Send switch to device** ==
1225
1226 **3.10.1 {{id name="_Toc24963760"/}}Parameters**
1227
1228 (% class="table-bordered" %)
1229 |(% style="width:102px" %)**acturl**|(% colspan="3" style="width:1059px" %)we-data/sendSwitchToDevice
1230 |(% style="width:102px" %)**Function**|(% colspan="3" style="width:1059px" %)Enable vbox reports real-time data, because now the vbox has added a real-time data switch function, only in the real-time data page vbox will report real-time data, otherwise it will not be reported. So if you need to keep to get real-time data, you need to call this interface first, and call it every 20 seconds, so that the vbox will continue to report real-time data.
1231 |(% colspan="1" rowspan="2" style="width:102px" %)**Parameters**|(% style="width:450px" %)Parameter|(% colspan="2" %)Description
1232 |(% style="width:450px" %)boxId|(% colspan="2" %)boxId(required)
1233 |(% rowspan="1" style="width:102px" %)**Return value**|(% style="width:450px" %)Field name|(% colspan="2" %)Description
1234
1235 = **Appendix** =
1236
1237 == (% style="color:inherit; font-family:inherit; font-size:26px" %)**Data type**(%%) ==
1238
1239 100: 16-bit binary
1240
1241 101: 16-bit octal
1242
1243 102: 16-bit hexadecimal
1244
1245 103: 16-bit BCD code
1246
1247 104: 16-bit signed decimal
1248
1249 105: 16-bit unsigned decimal
1250
1251 200: 32-bit binary
1252
1253 201: 32-bit octal
1254
1255 202: 32-bit hexadecimal
1256
1257 203: 32-bit BCD
1258
1259 204: 32-bit signed decimal
1260
1261 205: 32-bit unsigned decimal
1262
1263 206: 32-bit floating
1264
1265 400: 64-bit binary
1266
1267 401: 64-bit octal
1268
1269 402: 64-bit hexadecimal
1270
1271 403: 64-bit BCD
1272
1273 404: 64-bit signed decimal
1274
1275 405: 64-bit unsigned decimal
1276
1277 406: 64-bit floating
1278
1279 1000: string
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289 Version: V1.1.0
1290
1291 Date: Nov 2019