Skip to Content

Changes for page 07 HTTP API

Last modified by Devin Chen on 2025/06/30 14:16
From version 29.1
edited by Devin Chen
on 2025/06/30 14:16
Change comment: There is no comment for this version
To version 3.1
edited by Hunter
on 2022/07/11 10:41
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -07 HTTP API
1 +05 HTTP API
Parent
... ... @@ -1,1 +1,1 @@
1 -V-BOX.V-Net.Manual.WebHome
1 +V-BOX.V-Net.1\.User Manual.WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.DevinChen
1 +XWiki.Hunter
Content
... ... @@ -1,4 +1,4 @@
1 -= **General** =
1 += **1 General** =
2 2  
3 3  This documents introduces WECON V-BOX HTTP API. And this document also shows some examples. All example is tested from postman application.
4 4  
... ... @@ -19,15 +19,15 @@
19 19  [[http:~~/~~/api.eu.v-box.net>>url:http://api.v-box.net/]]
20 20  
21 21  (% style="text-align:center" %)
22 -[[image:V-BOX HTTP manual_html_ceb1e13ef4c1fa5d.png||height="361" width="800" class="img-thumbnail"]]
22 +[[image:V-BOX HTTP manual_html_ceb1e13ef4c1fa5d.png||class="img-thumbnail" height="361" width="800"]]
23 23  
24 24  For **ASEAN server** V-BOX, now can use http, the server address is api.asean.v-box.net.
25 25  
26 26  The common KEY is:
27 27  
28 -**comid=128**
28 +**comid=2**
29 29  
30 -**comkey=7e421dd30a394d74b7b9c079e67e272c**
30 +**comkey=589625dce895454dbff9782c299db156**
31 31  
32 32  screctkey=f1cd9351930d4e589922edbcf3b09a7c
33 33  
... ... @@ -43,19 +43,14 @@
43 43  
44 44  screctkey=f1cd9351930d4e589922edbcf3b09a7c
45 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 -)))
46 +== 1.1 Interface parameter description ==
50 50  
51 -== **Interface Parameter Description** ==
52 -
53 53  **Global parameters**
54 54  
55 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 56  
57 57  (% style="text-align:center" %)
58 -[[image:企业微信截图_20210531172144.png||height="467" width="800" class="img-thumbnail"]]
53 +[[image:企业微信截图_20210531172144.png||class="img-thumbnail" height="467" width="800"]]
59 59  
60 60  **The returned result represented by Json and case sensitive:**
61 61  
... ... @@ -67,12 +67,12 @@
67 67  
68 68  {"code" : 200 , "result": {}, "msg" : "ok", "reqId":"1502074141465"}
69 69  
70 -**Status Code**
65 +**State code description**
71 71  
72 72  (% style="text-align:center" %)
73 -[[image:1.png||height="141" width="500" class="img-thumbnail"]]
68 +[[image:1.png||class="img-thumbnail" height="141" width="500"]]
74 74  
75 -== **Example key and value** ==
70 +== **1.2 Example key and value** ==
76 76  
77 77  1).**comid**=2
78 78  
... ... @@ -83,27 +83,26 @@
83 83  4).**ts**=1573897380
84 84  
85 85  (((
86 -= **Basic API** =
81 += **2 Basic API** =
87 87  )))
88 88  
89 -== **{{id name="_Toc24963726"/}}Login operation** ==
84 +== **2.1 {{id name="_Toc24963726"/}}Login operation** ==
90 90  
91 91  (((
92 92  **2.1.1 Parameters**
93 93  )))
94 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)
90 +(% class="table-bordered" %)
91 +|**Acturl**|(% colspan="2" %)we-data/login
92 +|**Function**|(% colspan="2" %)Login with username, email, phone number
93 +|(% rowspan="3" %)**Parameters**|Items|Description
94 +|alias|Username, email, phone number
95 +|password|Password (Encrypted with md5, 32bit)
96 +|(% rowspan="3" %)**Return value**|Items|Description
97 +|utype|User Type: 1-Manage Account, 2-Viewer Account
98 +|sid|User session ID
105 105  
106 -**Operating procedures**
100 +**2.1.2 Operating procedures**
107 107  
108 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 109  
... ... @@ -114,7 +114,7 @@
114 114  
115 115   alias: weconuser
116 116  
117 - password: 599a3c736c04e196c58a29f43778f7ea(The md5 encryption result of Wecon159)
111 + password: 599a3c736c04e196c58a29f43778f7ea(Wecon159)
118 118  
119 119  (% style="text-align:center" %)
120 120  [[image:V-BOX HTTP manual_html_563261d83c8f3530.png||height="250" width="700" class="img-thumbnail"]]
... ... @@ -123,18 +123,8 @@
123 123  
124 124  alias=weconuser&comid=2&compvtkey=589625dce895454dbff9782c299db156&password=599a3c736c04e196c58a29f43778f7ea&ts=1573897380&key=f1cd9351930d4e589922edbcf3b09a7c
125 125  
126 -Put the whole string above encrypted by MD5, so will get the value of "sign"
120 +MD5 value: 997513ff1320862f0cbb9ce19d0bd253
127 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 138  **Step4: ** Set common of header
139 139  
140 140  {"comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"997513ff1320862f0cbb9ce19d0bd253"}
... ... @@ -143,7 +143,7 @@
143 143  [[image:V-BOX HTTP manual_html_cbfc9bbb7d0d4f84.png||height="230" width="700" class="img-thumbnail"]]
144 144  
145 145  (((
146 -**Result**
130 +**2.1.3 Result**
147 147  )))
148 148  
149 149  {
... ... @@ -170,22 +170,22 @@
170 170  [[image:V-BOX HTTP manual_html_b00e7e6a00828e27.png||height="291" width="500" class="img-thumbnail"]]
171 171  
172 172  (((
173 -= **Service data APIs** =
157 += **3 Service data APIs** =
174 174  )))
175 175  
176 -== **V-Box list** ==
160 +== **3.1 V-Box list** ==
177 177  
178 -**{{id name="_Toc24963732"/}}Parameters**
162 +**3.1.1 {{id name="_Toc24963732"/}}Parameters**
179 179  
180 180  (% style="text-align:center" %)
181 -[[image:X.png||height="412" width="700" class="img-thumbnail"]]
165 +[[image:X.png||class="img-thumbnail" height="412" width="700"]]
182 182  
183 -**~ {{id name="_Toc24963733"/}}Operating procedures**
167 +**3.1.2 {{id name="_Toc24963733"/}}Operating procedures**
184 184  
185 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 186  
187 187  (% style="text-align:center" %)
188 -[[image:V-BOX HTTP manual_html_7555868f6d398292.png||height="48" width="700" class="img-thumbnail"]]
172 +[[image:V-BOX HTTP manual_html_7555868f6d398292.png||class="img-thumbnail" height="48" width="700"]]
189 189  
190 190  **Step2:**  Set parameters on Params
191 191  
... ... @@ -202,9 +202,9 @@
202 202  {"sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"8fb4fbf99fcc1331c3274e708a403034"}
203 203  
204 204  (% style="text-align:center" %)
205 -[[image:V-BOX HTTP manual_html_999832f3a31ac851.png||height="232" width="700" class="img-thumbnail"]]
189 +[[image:V-BOX HTTP manual_html_999832f3a31ac851.png||class="img-thumbnail" height="232" width="700"]]
206 206  
207 -**Result**
191 +**3.1.3 Result**
208 208  
209 209  {
210 210  
... ... @@ -331,11 +331,11 @@
331 331  }
332 332  
333 333  (% style="text-align:center" %)
334 -[[image:V-BOX HTTP manual_html_5999b14ed63e8065.png||height="348" width="600" class="img-thumbnail"]]
318 +[[image:V-BOX HTTP manual_html_5999b14ed63e8065.png||class="img-thumbnail" height="348" width="600"]]
335 335  
336 -== **Real-time group list** ==
320 +== **3.2 Real-time group list** ==
337 337  
338 -**{{id name="_Toc24963736"/}} Parameters**
322 +**3.2.1{{id name="_Toc24963736"/}} Parameters**
339 339  
340 340  (% class="table-bordered" %)
341 341  |**acturl**|(% colspan="3" %)we-data/realgroups
... ... @@ -347,12 +347,12 @@
347 347  |groupId|Group ID
348 348  |groupName|Group name
349 349  
350 -**Operating procedures**
334 +**3.2.2 Operating procedures**
351 351  
352 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 353  
354 354  (% style="text-align:center" %)
355 -[[image:V-BOX HTTP manual_html_abb2159981171c6.png||height="46" width="700" class="img-thumbnail"]]
339 +[[image:V-BOX HTTP manual_html_abb2159981171c6.png||class="img-thumbnail" height="46" width="700"]]
356 356  
357 357  **Step2: **Set parameters on Params
358 358  
... ... @@ -359,7 +359,7 @@
359 359  "boxId": "973"
360 360  
361 361  (% style="text-align:center" %)
362 -[[image:V-BOX HTTP manual_html_5c3ab35ebdab144e.png||height="151" width="800" class="img-thumbnail"]]
346 +[[image:V-BOX HTTP manual_html_5c3ab35ebdab144e.png||class="img-thumbnail" height="151" width="800"]]
363 363  
364 364  **Step3: **Get sign
365 365  
... ... @@ -372,9 +372,9 @@
372 372  {"boxId":"973","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"9b267b7549083167954b7ede30916ff5"}
373 373  
374 374  (% style="text-align:center" %)
375 -[[image:V-BOX HTTP manual_html_cc06cac462c1b77a.png||height="172" width="800" class="img-thumbnail"]]
359 +[[image:V-BOX HTTP manual_html_cc06cac462c1b77a.png||class="img-thumbnail" height="172" width="800"]]
376 376  
377 -**Result**
361 +**3.2.3 Result**
378 378  
379 379  {
380 380  
... ... @@ -420,19 +420,18 @@
420 420  
421 421  [[image:V-BOX HTTP manual_html_2445c358293d621.png||height="531" width="532"]]
422 422  
423 -== **Real-time tags configuration list** ==
407 +== **3.3 Real-time tags configuration list** ==
424 424  
425 -**Parameters**
409 +**3.3.1 Parameters**
426 426  
427 427  (% class="table-bordered" %)
428 428  |**acturl**|(% colspan="3" %)we-data/realcfgs
429 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
414 +|(% rowspan="5" %)**Parameters**|Parameter|(% colspan="2" %)Description
431 431  |boxId|(% colspan="2" %)VBoxID(“None” means custom tags grouping)
432 432  |groupId|(% colspan="2" %)Group ID (Required)
433 433  |pageSize|(% colspan="2" %)Number of each page, 10 by default
434 434  |pageIndex|(% colspan="2" %)Number of current page, start from 1
435 -|devType|(% colspan="2" %)Device type (0:Box, 1:HMI)
436 436  |(% rowspan="15" %)**Return value**|Field name|(% colspan="2" %)Description
437 437  |(% rowspan="11" %)cfgList|monitorId|Tags ID
438 438  |monitorName|Tags name
... ... @@ -465,12 +465,12 @@
465 465  |totalRecord|(% colspan="2" %)Total record number
466 466  |currentPage|(% colspan="2" %)Current page number
467 467  
468 -**Operating procedures**
451 +**3.3.2 Operating procedures**
469 469  
470 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 471  
472 472  (% style="text-align:center" %)
473 -[[image:V-BOX HTTP manual_html_3fff373ae27e2e00.png||height="44" width="700" class="img-thumbnail"]]
456 +[[image:V-BOX HTTP manual_html_3fff373ae27e2e00.png||class="img-thumbnail" height="44" width="700"]]
474 474  
475 475  **Step2: **Set parameters on Params
476 476  
... ... @@ -478,185 +478,101 @@
478 478  
479 479  "groupId":"7325"
480 480  
481 -"devType":"0"
482 -
483 483  "pageSize":"5"
484 484  
485 485  "pageIndex":"2"
486 486  
487 487  (% style="text-align:center" %)
488 -[[image:1751263596452-675.png||height="222" width="555"]]
469 +[[image:V-BOX HTTP manual_html_52bf7d95165a3e3a.png||class="img-thumbnail" height="273" width="700"]]
489 489  
490 490  **Step3:** Get sign
491 491  
492 -boxId=763&comid=128&compvtkey=7e421dd30a394d74b7b9c079e67e272c&devType=0&groupId=211608&pageIndex=1&pageSize=5&sid=0e583b1f48cf467bbf738365b3da1a26&ts=1751263335125&key=f1cd9351930d4e589922edbcf3b09a7c
473 +boxId=973&comid=2&compvtkey=589625dce895454dbff9782c299db156&groupId=7325&pageIndex=2&pageSize=5&sid=2d7bfd344aa64d8ebc9beea0e4dad8ad&ts=1573897380&key=f1cd9351930d4e589922edbcf3b09a7c
493 493  
494 -MD5 sign: 27a89c93a4990d0497a8bd47dea4aed3
475 +MD5 sign: 0769228e66c945eed5431c41a96949f2
495 495  
496 496  **Step4:** Set common of header
497 497  
498 -{"compvtkey":"7e421dd30a394d74b7b9c079e67e272c","sign":"27a89c93a4990d0497a8bd47dea4aed3","comid":"128","sid":"0e583b1f48cf467bbf738365b3da1a26","ts":1751263335125}
479 +{"boxId":"973","groupId":"7325","pageSize":"5","pageIndex":"2","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"0769228e66c945eed5431c41a96949f2"}
499 499  
500 500  (% style="text-align:center" %)
501 -[[image:1751263680622-643.png]]
482 +[[image:V-BOX HTTP manual_html_d284dfdd7b4844ee.png||class="img-thumbnail" height="288" width="800"]]
502 502  
503 -**Result**
484 +**3.3.3 Result**
504 504  
505 505  {
506 506  
507 - "code": 200,
488 + "code": 200,
508 508  
509 - "msg": "ok",
490 + "msg": "ok",
510 510  
511 - "reqId": "1751263500705",
492 + "reqId": "1573903822419",
512 512  
513 - "result": {
494 + "result": {
514 514  
515 - "cfgList": [
496 + "cfgList": [
516 516  
517 517   {
518 518  
519 - "monitorId": 2276374,
500 + "monitorId": 91545,
520 520  
521 - "monitorName": "x0",
502 + "dataId": 105,
522 522  
523 - "digitBinary": "",
504 + "monitorName": "Temp_9",
524 524  
525 - "float_point": -1,
506 + "updTime": 1571965761000,
526 526  
527 - "rid": "X",
508 + "dataLimit": "0 7999",
528 528  
529 - "roleType": 1,
510 + "digitBinary": "十进制",
530 530  
531 - "string_point": -1,
512 + "addr": "9",
532 532  
533 - "dataId": 105,
514 + "rid": "D",
534 534  
535 - "addr_stat_no": -1,
516 + "roleType": 3,
536 536  
537 - "updTime": 1745481123000,
518 + "digitCount": "5,0",
538 538  
539 - "dataLimit": "0 1",
520 + "addrType": 2
540 540  
541 - "addr": "0",
542 -
543 - "digitCount": "",
544 -
545 - "boxId": 763,
546 -
547 - "addrType": 0
548 -
549 549   },
550 550  
551 - {
524 + ……………
552 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 585   {
586 586  
587 - "monitorId": 2276367,
528 + "monitorId": 91541,
588 588  
589 - "monitorName": "okg",
530 + "dataId": 105,
590 590  
591 - "digitBinary": "",
532 + "monitorName": "Temp_5",
592 592  
593 - "float_point": 1,
534 + "updTime": 1571965761000,
594 594  
595 - "rid": "HDW",
536 + "dataLimit": "0 7999",
596 596  
597 - "roleType": 3,
538 + "digitBinary": "十进制",
598 598  
599 - "string_point": -1,
540 + "addr": "5",
600 600  
601 - "dataId": 105,
542 + "rid": "D",
602 602  
603 - "addr_stat_no": -1,
544 + "roleType": 3,
604 604  
605 - "updTime": 1745475213000,
546 + "digitCount": "5,0",
606 606  
607 - "dataLimit": "0 299999",
548 + "addrType": 2
608 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 651   }
652 652  
653 653   ],
654 654  
655 - "totalPage": 1,
554 + "totalPage": 3,
656 656  
657 - "totalRecord": 4,
556 + "totalRecord": 15,
658 658  
659 - "currentPage": 1
558 + "currentPage": 2
660 660  
661 661   }
662 662  
... ... @@ -663,25 +663,20 @@
663 663  }
664 664  
665 665  (% style="text-align:center" %)
666 -[[image:1751263773173-191.png]]
565 +[[image:V-BOX HTTP manual_html_e7271097b71941cc.png||class="img-thumbnail" height="644" width="800"]]
667 667  
668 -== **Tags data list** ==
567 +== (% id="cke_bm_1151S" style="display:none" %)** {{id name="_Toc24963743"/}}**(%%)**3.4 Tags data list** ==
669 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}}
569 +**3.4.1 {{id name="_Toc24963744"/}}Parameters**
673 673  
674 -**~ {{id name="_Toc24963744"/}}Parameters**
675 -
676 676  (% class="table-bordered" %)
677 677  |**acturl**|(% colspan="3" %)we-data/realdata
678 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
574 +|(% rowspan="5" %)**Parameters**|Parameter|(% colspan="2" %)Description
680 680  |boxId|(% colspan="2" %)VBoxID(“None” means custom tag grouping)
681 681  |groupId|(% colspan="2" %)Group ID (Required)
682 682  |pageSize|(% colspan="2" %)Number of each page, 10 by default
683 683  |pageIndex|(% colspan="2" %)Number of current page, start from 1
684 -|devType|(% colspan="2" %)Device type (0:Box, 1:HMI)
685 685  |(% rowspan="11" %)**Return value**|Field name|(% colspan="2" %)Description
686 686  |(% rowspan="7" %)List|(% colspan="2" %)Real-time data list
687 687  |com|Communication port ID
... ... @@ -694,19 +694,17 @@
694 694  |totalRecord|(% colspan="2" %)Total record
695 695  |currentPage|(% colspan="2" %)current page
696 696  
697 -**~ {{id name="_Toc24963745"/}}Operating procedures**
591 +**3.4.2 {{id name="_Toc24963745"/}}Operating procedures**
698 698  
699 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 700  
701 701  (% style="text-align:center" %)
702 -[[image:V-BOX HTTP manual_html_839fb0577dac88c1.png||height="45" width="700" class="img-thumbnail"]]
596 +[[image:V-BOX HTTP manual_html_839fb0577dac88c1.png||class="img-thumbnail" height="45" width="700"]]
703 703  
704 704  **Step2: **Set parameters on Params
705 705  
706 706  "boxId":"973"
707 707  
708 -"devType":"0"
709 -
710 710  "groupId":"7325"
711 711  
712 712  "pageSize":"5"
... ... @@ -714,149 +714,73 @@
714 714  "pageIndex":"2"
715 715  
716 716  (% style="text-align:center" %)
717 -[[image:1751264089450-269.png||height="221" width="607"]]
609 +[[image:V-BOX HTTP manual_html_b860bab44ebbc128.png||class="img-thumbnail" height="272" width="700"]]
718 718  
719 719  **Step3:** Get sign
720 720  
721 -boxId=763&comid=128&compvtkey=7e421dd30a394d74b7b9c079e67e272c&devType=0&groupId=211608&pageIndex=1&pageSize=5&sid=0e583b1f48cf467bbf738365b3da1a26&ts=1751263921050&key=f1cd9351930d4e589922edbcf3b09a7c
613 +boxId=973&comid=2&compvtkey=589625dce895454dbff9782c299db156&groupId=7325&pageIndex=2&pageSize=5&sid=2d7bfd344aa64d8ebc9beea0e4dad8ad&ts=1573897380&key=f1cd9351930d4e589922edbcf3b09a7c
722 722  
723 -MD5 sign: 19191b155e92f800f4db086bf06f8367
615 +MD5 sign: 0769228e66c945eed5431c41a96949f2
724 724  
725 -{"compvtkey":"7e421dd30a394d74b7b9c079e67e272c","sign":"19191b155e92f800f4db086bf06f8367","comid":"128","sid":"0e583b1f48cf467bbf738365b3da1a26","ts":1751263921050}
617 +{"boxId":"973","groupId":"7325","pageSize":"5","pageIndex":"2","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"0769228e66c945eed5431c41a96949f2"}
726 726  
727 -**~ {{id name="_Toc24963746"/}}Result**
619 +**3.4.3 {{id name="_Toc24963746"/}}Result**
728 728  
729 729  {
730 730  
731 - "code": 200,
623 + "code": 200,
732 732  
733 - "msg": "ok",
625 + "msg": "ok",
734 734  
735 - "reqId": "1751264055206",
627 + "reqId": "1573905679365",
736 736  
737 - "result": {
629 + "result": {
738 738  
739 - "totalPage": 1,
631 + "totalPage": 3,
740 740  
741 - "list": [
633 + "list": [
742 742  
743 743   {
744 744  
745 - "com": 0,
637 + "com": 2939,
746 746  
747 - "string_point": -1,
639 + "monitorId": 91545,
748 748  
749 - "monitorId": 2276374,
641 + "monitorName": "Temp_9",
750 750  
751 - "addr_stat_no": -1,
643 + "groupId": 0,
752 752  
753 - "actAuth": 1,
645 + "state": "1",
754 754  
755 - "monitorName": "x0",
647 + "value": "90"
756 756  
757 - "groupId": 211608,
758 -
759 - "state": 0,
760 -
761 - "float_point": -1,
762 -
763 - "templateId": 0,
764 -
765 - "value": "0",
766 -
767 - "boxId": 763
768 -
769 769   },
770 770  
771 - {
651 + …………
772 772  
773 - "com": 0,
774 -
775 - "string_point": -1,
776 -
777 - "monitorId": 2276373,
778 -
779 - "addr_stat_no": -1,
780 -
781 - "actAuth": 3,
782 -
783 - "monitorName": "y0",
784 -
785 - "groupId": 211608,
786 -
787 - "state": 0,
788 -
789 - "float_point": -1,
790 -
791 - "templateId": 0,
792 -
793 - "value": "0",
794 -
795 - "boxId": 763
796 -
797 797   },
798 798  
799 799   {
800 800  
801 - "com": 0,
657 + "com": 2939,
802 802  
803 - "string_point": -1,
659 + "monitorId": 91541,
804 804  
805 - "monitorId": 2276367,
661 + "monitorName": "Temp_5",
806 806  
807 - "addr_stat_no": -1,
663 + "groupId": 0,
808 808  
809 - "actAuth": 3,
665 + "state": "1",
810 810  
811 - "monitorName": "okg",
667 + "value": "87"
812 812  
813 - "groupId": 211608,
814 -
815 - "state": 0,
816 -
817 - "float_point": 1,
818 -
819 - "templateId": 0,
820 -
821 - "value": "0",
822 -
823 - "boxId": 763
824 -
825 - },
826 -
827 - {
828 -
829 - "com": 0,
830 -
831 - "string_point": -1,
832 -
833 - "monitorId": 2276366,
834 -
835 - "addr_stat_no": -1,
836 -
837 - "actAuth": 3,
838 -
839 - "monitorName": "hjdfh",
840 -
841 - "groupId": 211608,
842 -
843 - "state": 0,
844 -
845 - "float_point": -1,
846 -
847 - "templateId": 0,
848 -
849 - "value": "0",
850 -
851 - "boxId": 763
852 -
853 853   }
854 854  
855 855   ],
856 856  
857 - "totalRecord": 4,
673 + "totalRecord": 15,
858 858  
859 - "currentPage": 1
675 + "currentPage": 2
860 860  
861 861   }
862 862  
... ... @@ -863,55 +863,52 @@
863 863  }
864 864  
865 865  (% style="text-align:center" %)
866 -[[image:1751264191566-865.png]]
682 +[[image:V-BOX HTTP manual_html_705682e81eae5ea7.png||class="img-thumbnail" height="651" width="800"]]
867 867  
868 -== **Modify tag data** ==
684 +== **3.5 Modify tag data** ==
869 869  
870 870  (((
871 -**Parameters**
687 +**3.5.1 Parameters**
872 872  )))
873 873  
874 874  (% class="table-bordered" %)
875 875  |**acturl**|(% colspan="2" %)we-data/updrealdata
876 876  |**Functions**|(% colspan="2" %)Modify tag data
877 -|(% rowspan="5" %)**Parameters**|Parameter|Description
878 -|boxId|Box ID
693 +|(% rowspan="3" %)**Parameters**|Parameter|Description
879 879  |monitorId|Tag ID
880 880  |value|value
881 -|devType|Device type (0:Box, 1:HMI)
882 882  |**Return value**|(% colspan="2" %)None
883 883  
884 -**Operating procedures**
698 +**3.5.2 Operating procedures**
885 885  
886 886  **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]]
887 887  
888 888  (% style="text-align:center" %)
889 -[[image:1651915094120-525.png||height="45" width="700" class="img-thumbnail"]]
703 +[[image:1651915094120-525.png||class="img-thumbnail" height="45" width="700"]]
890 890  
891 891  **Step2:** Set parameters on Params
892 892  
893 -boxId:6397578
894 -monitorId:1001
895 -value:66
896 -devType:1
707 +"monitorId":"91541"
897 897  
709 +"value":"60"
710 +
898 898  (% style="text-align:center" %)
899 -[[image:1746502882467-849.png]]
712 +[[image:V-BOX HTTP manual_html_5a3153add75ca7b4.png||class="img-thumbnail" height="246" width="800"]]
900 900  
901 901  **Step3:** Get sign
902 902  
903 -boxId=6397578&comid=128&compvtkey=7e421dd30a394d74b7b9c079e67e272c&devType=1&monitorId=1001&sid=d8c98edd64da40289fef565c94924fe5&ts=171746501715435&value=66&key=f1cd9351930d4e589922edbcf3b09a7c
716 +comid=2&compvtkey=589625dce895454dbff9782c299db156&monitorId=91541&sid=2d7bfd344aa64d8ebc9beea0e4dad8ad&ts=1573897380&value=60&key=f1cd9351930d4e589922edbcf3b09a7c
904 904  
905 -MD5 sign: 4802a362fde2ca5053ad79fe4d272200
718 +MD5 sign: 4119b1abc9176a187f781bece04a5296
906 906  
907 907  **Step4: **Set common of header
908 908  
909 -{"compvtkey":"7e421dd30a394d74b7b9c079e67e272c","sign":"4802a362fde2ca5053ad79fe4d272200","comid":"128","sid":"d8c98edd64da40289fef565c94924fe5","ts":171746501715435}
722 +{"monitorId":"91541","value":"60","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"4119b1abc9176a187f781bece04a5296"}
910 910  
911 911  (% style="text-align:center" %)
912 -[[image:1746503047845-902.png]]
725 +[[image:V-BOX HTTP manual_html_59d54a5d886ef614.png||class="img-thumbnail" height="244" width="700"]]
913 913  
914 -**Result**
727 +**3.5.3 Result**
915 915  
916 916  {
917 917  
... ... @@ -926,29 +926,28 @@
926 926  }
927 927  
928 928  (% style="text-align:center" %)
929 -[[image:1746503002289-932.png]]
742 +[[image:V-BOX HTTP manual_html_590c8dab9e80fd0f.png||class="img-thumbnail" height="425" width="700"]]
930 930  
931 -== **Historical tags name list** ==
744 +== **3.6 {{id name="_Toc24963751"/}}Historical tags name list** ==
932 932  
933 -**Parameters**
746 +**3.6.1 Parameters**
934 934  
935 935  (% class="table-bordered" %)
936 936  |**acturl**|(% colspan="3" %)we-data/monitors
937 937  |**Functions**|(% colspan="3" %)Get a list of historical tags
938 -|(% rowspan="3" %)**Parameters**|Parameter|(% colspan="2" %)Description
939 -|boxId|(% colspan="2" %)Box ID (Not required)
940 -|devType|(% colspan="2" %)Device type (0:Box, 1:HMI)
751 +|(% rowspan="2" %)**Parameters**|Parameter|(% colspan="2" %)Description
752 +|boxId|(% colspan="2" %)VBoxID (Not required)
941 941  |(% rowspan="4" %)**Return value**|Field name|(% colspan="2" %)Description
942 942  |(% rowspan="3" %)list|(% colspan="2" %)Tag list
943 943  |monitorId|tag ID
944 944  |monitorName|tag name
945 945  
946 -**Operating procedures**
758 +**​​​​​​​3.6.2 Operating procedures**
947 947  
948 948  **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]]
949 949  
950 950  (% style="text-align:center" %)
951 -[[image:V-BOX HTTP manual_html_456f00c6af3ea1b7.png||height="45" width="700" class="img-thumbnail"]]
763 +[[image:V-BOX HTTP manual_html_456f00c6af3ea1b7.png||class="img-thumbnail" height="45" width="700"]]
952 952  
953 953  **Step2: **Set parameters on Params
954 954  
... ... @@ -955,7 +955,7 @@
955 955  "boxId":"973"
956 956  
957 957  (% style="text-align:center" %)
958 -[[image:V-BOX HTTP manual_html_8bf7c3f9b3ce3897.png||height="185" width="700" class="img-thumbnail"]]
770 +[[image:V-BOX HTTP manual_html_8bf7c3f9b3ce3897.png||class="img-thumbnail" height="185" width="700"]]
959 959  
960 960  **Step3:** Get sign
961 961  
... ... @@ -968,9 +968,9 @@
968 968  {"boxId":"973","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"9b267b7549083167954b7ede30916ff5"}
969 969  
970 970  (% style="text-align:center" %)
971 -[[image:V-BOX HTTP manual_html_dba52ac718eeb66e.png||height="228" width="700" class="img-thumbnail"]]
783 +[[image:V-BOX HTTP manual_html_dba52ac718eeb66e.png||class="img-thumbnail" height="228" width="700"]]
972 972  
973 -**Result**
785 +**​​​​​​​3.6.3 Result**
974 974  
975 975  {
976 976  
... ... @@ -1011,11 +1011,11 @@
1011 1011  }
1012 1012  
1013 1013  (% style="text-align:center" %)
1014 -[[image:V-BOX HTTP manual_html_2a739377a9fb10b2.png||height="400" width="700" class="img-thumbnail"]]
826 +[[image:V-BOX HTTP manual_html_2a739377a9fb10b2.png||class="img-thumbnail" height="400" width="700"]]
1015 1015  
1016 -== **Historical tag data list** ==
828 +== (% id="cke_bm_1218S" style="display:none" %)** **(%%)**3.7 {{id name="_Toc24963755"/}}Historical tag data list** ==
1017 1017  
1018 -**~ {{id name="_Toc24963756"/}}Parameters**
830 +**​​​​​​​3.7.1 {{id name="_Toc24963756"/}}Parameters**
1019 1019  
1020 1020  (% class="table-bordered" %)
1021 1021  |**acturl**|(% colspan="3" %)we-data/historydata
... ... @@ -1035,12 +1035,12 @@
1035 1035  |totalRecord|(% colspan="2" %)Total records
1036 1036  |currentPage|(% colspan="2" %)Current page
1037 1037  
1038 -**Operating procedures**
850 +​​​​​​​**3.7.2 Operating procedures**
1039 1039  
1040 1040  **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]]
1041 1041  
1042 1042  (% style="text-align:center" %)
1043 -[[image:V-BOX HTTP manual_html_cd2fdea1493dc20e.png||height="47" width="700" class="img-thumbnail"]]
855 +[[image:V-BOX HTTP manual_html_cd2fdea1493dc20e.png||class="img-thumbnail" height="47" width="700"]]
1044 1044  
1045 1045  **Step2:** Set parameters on Params
1046 1046  
... ... @@ -1055,7 +1055,7 @@
1055 1055  "pageIndex":"2"
1056 1056  
1057 1057  (% style="text-align:center" %)
1058 -[[image:V-BOX HTTP manual_html_f169ff87c20ce6c4.png||height="302" width="700" class="img-thumbnail"]]
870 +[[image:V-BOX HTTP manual_html_f169ff87c20ce6c4.png||class="img-thumbnail" height="302" width="700"]]
1059 1059  
1060 1060  **Step3: **Get sign
1061 1061  
... ... @@ -1068,9 +1068,9 @@
1068 1068  {"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"}
1069 1069  
1070 1070  (% style="text-align:center" %)
1071 -[[image:V-BOX HTTP manual_html_fac48b1179b555ee.png||height="291" width="700" class="img-thumbnail"]]
883 +[[image:V-BOX HTTP manual_html_fac48b1179b555ee.png||class="img-thumbnail" height="291" width="700"]]
1072 1072  
1073 -**Result**
885 +**3.7.3 Result**
1074 1074  
1075 1075  {
1076 1076  
... ... @@ -1131,16 +1131,16 @@
1131 1131  }
1132 1132  
1133 1133  (% style="text-align:center" %)
1134 -[[image:V-BOX HTTP manual_html_f3b62eb69687a214.png||height="476" width="700" class="img-thumbnail"]]
946 +[[image:V-BOX HTTP manual_html_f3b62eb69687a214.png||class="img-thumbnail" height="476" width="700"]]
1135 1135  
1136 -== **Alarm tags data list** ==
948 +== **3.8 Alarm tags data list** ==
1137 1137  
1138 -**{{id name="_Toc24963760"/}}Parameters**
950 +**​​​​​​​​​​​​​​3.8.1 {{id name="_Toc24963760"/}}Parameters**
1139 1139  
1140 1140  (% class="table-bordered" %)
1141 1141  |**acturl**|(% colspan="3" %)we-data/alarmdata
1142 1142  |**Function**|(% colspan="3" %)Get alarm data
1143 -|(% rowspan="10" %)**Parameters**|Parameter|(% colspan="2" %)Description
955 +|(% rowspan="9" %)**Parameters**|Parameter|(% colspan="2" %)Description
1144 1144  |boxId|(% colspan="2" %)VBoxID, (Required)
1145 1145  |monitorBeginTime|(% colspan="2" %)Monitoring start time, (Not required)
1146 1146  |monitorEndTime|(% colspan="2" %)Monitoring end time, (Not required)
... ... @@ -1157,7 +1157,6 @@
1157 1157  
1158 1158  (Not necessary)
1159 1159  )))
1160 -|devType|(% colspan="2" %)Device type (0:Box, 1:HMI)
1161 1161  |(% rowspan="12" %)**Return value**|Field name|(% colspan="2" %)Description
1162 1162  |(% rowspan="8" %)List|(% colspan="2" %)Alarm data list
1163 1163  |monitorId|tag ID
... ... @@ -1171,12 +1171,12 @@
1171 1171  |totalRecord|(% colspan="2" %)Total records
1172 1172  |currentPage|(% colspan="2" %)Current page
1173 1173  
1174 -**~ {{id name="_Toc24963761"/}}Operating procedures**
985 +**​​​​​​​​​​​​​​3.8.2 {{id name="_Toc24963761"/}}Operating procedures**
1175 1175  
1176 1176  **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]]
1177 1177  
1178 1178  (% style="text-align:center" %)
1179 -[[image:V-BOX HTTP manual_html_4ebee4d4fcf0097c.png||height="45" width="700" class="img-thumbnail"]]
990 +[[image:V-BOX HTTP manual_html_4ebee4d4fcf0097c.png||class="img-thumbnail" height="45" width="700"]]
1180 1180  
1181 1181  **Step2:** Set parameters on Params
1182 1182  
... ... @@ -1193,7 +1193,7 @@
1193 1193  "state":"2"
1194 1194  
1195 1195  (% style="text-align:center" %)
1196 -[[image:V-BOX HTTP manual_html_2361d0eaa7447a9c.png||height="327" width="700" class="img-thumbnail"]]
1007 +[[image:V-BOX HTTP manual_html_2361d0eaa7447a9c.png||class="img-thumbnail" height="327" width="700"]]
1197 1197  
1198 1198  **Step3:** Get sign
1199 1199  
... ... @@ -1206,9 +1206,9 @@
1206 1206  {"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"}
1207 1207  
1208 1208  (% style="text-align:center" %)
1209 -[[image:V-BOX HTTP manual_html_cd9ce84648b86cb9.png||height="269" width="700" class="img-thumbnail"]]
1020 +[[image:V-BOX HTTP manual_html_cd9ce84648b86cb9.png||class="img-thumbnail" height="269" width="700"]]
1210 1210  
1211 -**Result**
1022 +**3.8.3 Result**
1212 1212  
1213 1213  {
1214 1214  
... ... @@ -1285,11 +1285,11 @@
1285 1285  }
1286 1286  
1287 1287  (% style="text-align:center" %)
1288 -[[image:V-BOX HTTP manual_html_d4a3e0114c402c27.png||height="475" width="700" class="img-thumbnail"]]
1099 +[[image:V-BOX HTTP manual_html_d4a3e0114c402c27.png||class="img-thumbnail" height="475" width="700"]]
1289 1289  
1290 -== **Get device state** ==
1101 +== **3.9 Get device state** ==
1291 1291  
1292 -**~ {{id name="_Toc24963760"/}}Parameters**
1103 +**3.9.1 {{id name="_Toc24963760"/}}Parameters**
1293 1293  
1294 1294  (% class="table-bordered" %)
1295 1295  |**acturl**|(% colspan="3" %)we-data/getDeviceState
... ... @@ -1299,7 +1299,7 @@
1299 1299  |(% rowspan="2" %)**Return value**|Field name|(% colspan="2" %)Description
1300 1300  |state|(% colspan="2" %)vbox state: 1-online,  0-offline
1301 1301  
1302 -== **Send switch to device** ==
1113 +== **3.10 Send switch to device** ==
1303 1303  
1304 1304  **3.10.1 {{id name="_Toc24963760"/}}Parameters**
1305 1305  
... ... @@ -1310,9 +1310,9 @@
1310 1310  |(% style="width:450px" %)boxId|(% colspan="2" %)boxId(required)
1311 1311  |(% rowspan="1" style="width:102px" %)**Return value**|(% style="width:450px" %)Field name|(% colspan="2" %)Description
1312 1312  
1313 -= **Appendix** =
1124 += **4 Appendix** =
1314 1314  
1315 -== (% style="color:inherit; font-family:inherit; font-size:26px" %)**Data type**(%%) ==
1126 +== (% style="color:inherit; font-family:inherit; font-size:26px" %)**4.1 Data type**(%%) ==
1316 1316  
1317 1317  100: 16-bit binary
1318 1318  
1746502870811-166.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.DevinChen
Size
... ... @@ -1,1 +1,0 @@
1 -36.4 KB
Content
1746502882467-849.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.DevinChen
Size
... ... @@ -1,1 +1,0 @@
1 -36.4 KB
Content
1746503002289-932.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.DevinChen
Size
... ... @@ -1,1 +1,0 @@
1 -20.3 KB
Content
1746503047845-902.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.DevinChen
Size
... ... @@ -1,1 +1,0 @@
1 -42.1 KB
Content
1751263559328-234.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.DevinChen
Size
... ... @@ -1,1 +1,0 @@
1 -14.7 KB
Content
1751263596452-675.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.DevinChen
Size
... ... @@ -1,1 +1,0 @@
1 -22.9 KB
Content
1751263680622-643.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.DevinChen
Size
... ... @@ -1,1 +1,0 @@
1 -27.1 KB
Content
1751263773173-191.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.DevinChen
Size
... ... @@ -1,1 +1,0 @@
1 -28.5 KB
Content
1751264089450-269.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.DevinChen
Size
... ... @@ -1,1 +1,0 @@
1 -23.2 KB
Content
1751264191566-865.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.DevinChen
Size
... ... @@ -1,1 +1,0 @@
1 -26.1 KB
Content