Skip to Content

Changes for page 07 HTTP API

Last modified by Devin Chen on 2025/04/10 16:16
From version 16.1
edited by Mora Zhou
on 2023/12/22 10:06
Change comment: There is no comment for this version
To version 14.1
edited by Mora Zhou
on 2023/11/22 13:54
Change comment: There is no comment for this version

Summary

Details

Page properties
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  
... ... @@ -48,7 +48,7 @@
48 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 49  )))
50 50  
51 -== **Interface Parameter Description** ==
51 +== **1.1 Interface Parameter Description** ==
52 52  
53 53  **Global parameters**
54 54  
... ... @@ -72,7 +72,7 @@
72 72  (% style="text-align:center" %)
73 73  [[image:1.png||height="141" width="500" class="img-thumbnail"]]
74 74  
75 -== **Example key and value** ==
75 +== **1.2 Example key and value** ==
76 76  
77 77  1).**comid**=2
78 78  
... ... @@ -83,10 +83,10 @@
83 83  4).**ts**=1573897380
84 84  
85 85  (((
86 -= **Basic API** =
86 += **2 Basic API** =
87 87  )))
88 88  
89 -== **{{id name="_Toc24963726"/}}Login operation** ==
89 +== **2.1 {{id name="_Toc24963726"/}}Login operation** ==
90 90  
91 91  (((
92 92  **2.1.1 Parameters**
... ... @@ -103,7 +103,7 @@
103 103  |utype|(% style="width:535px" %)User Type: 1-Manage Account, 2-Viewer Account
104 104  |sid|(% style="width:535px" %)User session ID (Only available for 12 hours)
105 105  
106 -**Operating procedures**
106 +**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  
... ... @@ -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**
146 +**2.1.3 Result**
147 147  )))
148 148  
149 149  {
... ... @@ -170,17 +170,17 @@
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** =
173 += **3 Service data APIs** =
174 174  )))
175 175  
176 -== **V-Box list** ==
176 +== **3.1 V-Box list** ==
177 177  
178 -**{{id name="_Toc24963732"/}}Parameters**
178 +**3.1.1 {{id name="_Toc24963732"/}}Parameters**
179 179  
180 180  (% style="text-align:center" %)
181 181  [[image:X.png||height="412" width="700" class="img-thumbnail"]]
182 182  
183 -**~ {{id name="_Toc24963733"/}}Operating procedures**
183 +**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  
... ... @@ -204,7 +204,7 @@
204 204  (% style="text-align:center" %)
205 205  [[image:V-BOX HTTP manual_html_999832f3a31ac851.png||height="232" width="700" class="img-thumbnail"]]
206 206  
207 -**Result**
207 +**3.1.3 Result**
208 208  
209 209  {
210 210  
... ... @@ -333,9 +333,9 @@
333 333  (% style="text-align:center" %)
334 334  [[image:V-BOX HTTP manual_html_5999b14ed63e8065.png||height="348" width="600" class="img-thumbnail"]]
335 335  
336 -== **Real-time group list** ==
336 +== **3.2 Real-time group list** ==
337 337  
338 -**{{id name="_Toc24963736"/}} Parameters**
338 +**3.2.1{{id name="_Toc24963736"/}} Parameters**
339 339  
340 340  (% class="table-bordered" %)
341 341  |**acturl**|(% colspan="3" %)we-data/realgroups
... ... @@ -347,7 +347,7 @@
347 347  |groupId|Group ID
348 348  |groupName|Group name
349 349  
350 -**Operating procedures**
350 +**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  
... ... @@ -374,7 +374,7 @@
374 374  (% style="text-align:center" %)
375 375  [[image:V-BOX HTTP manual_html_cc06cac462c1b77a.png||height="172" width="800" class="img-thumbnail"]]
376 376  
377 -**Result**
377 +**3.2.3 Result**
378 378  
379 379  {
380 380  
... ... @@ -420,9 +420,9 @@
420 420  
421 421  [[image:V-BOX HTTP manual_html_2445c358293d621.png||height="531" width="532"]]
422 422  
423 -== **Real-time tags configuration list** ==
423 +== **3.3 Real-time tags configuration list** ==
424 424  
425 -**Parameters**
425 +**3.3.1 Parameters**
426 426  
427 427  (% class="table-bordered" %)
428 428  |**acturl**|(% colspan="3" %)we-data/realcfgs
... ... @@ -464,7 +464,7 @@
464 464  |totalRecord|(% colspan="2" %)Total record number
465 465  |currentPage|(% colspan="2" %)Current page number
466 466  
467 -**Operating procedures**
467 +**3.3.2 Operating procedures**
468 468  
469 469  **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]]
470 470  
... ... @@ -497,7 +497,7 @@
497 497  (% style="text-align:center" %)
498 498  [[image:V-BOX HTTP manual_html_d284dfdd7b4844ee.png||height="288" width="800" class="img-thumbnail"]]
499 499  
500 -**Result**
500 +**3.3.3 Result**
501 501  
502 502  {
503 503  
... ... @@ -580,9 +580,9 @@
580 580  (% style="text-align:center" %)
581 581  [[image:V-BOX HTTP manual_html_e7271097b71941cc.png||height="644" width="800" class="img-thumbnail"]]
582 582  
583 -== **Tags data list** ==
583 +== (% id="cke_bm_1151S" style="display:none" %)** {{id name="_Toc24963743"/}}**(%%)**3.4 Tags data list** ==
584 584  
585 -**~ {{id name="_Toc24963744"/}}Parameters**
585 +**3.4.1 {{id name="_Toc24963744"/}}Parameters**
586 586  
587 587  (% class="table-bordered" %)
588 588  |**acturl**|(% colspan="3" %)we-data/realdata
... ... @@ -604,7 +604,7 @@
604 604  |totalRecord|(% colspan="2" %)Total record
605 605  |currentPage|(% colspan="2" %)current page
606 606  
607 -**~ {{id name="_Toc24963745"/}}Operating procedures**
607 +**3.4.2 {{id name="_Toc24963745"/}}Operating procedures**
608 608  
609 609  **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]]
610 610  
... ... @@ -632,7 +632,7 @@
632 632  
633 633  {"boxId":"973","groupId":"7325","pageSize":"5","pageIndex":"2","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"0769228e66c945eed5431c41a96949f2"}
634 634  
635 -**~ {{id name="_Toc24963746"/}}Result**
635 +**3.4.3 {{id name="_Toc24963746"/}}Result**
636 636  
637 637  {
638 638  
... ... @@ -697,10 +697,10 @@
697 697  (% style="text-align:center" %)
698 698  [[image:V-BOX HTTP manual_html_705682e81eae5ea7.png||height="651" width="800" class="img-thumbnail"]]
699 699  
700 -== **Modify tag data** ==
700 +== **3.5 Modify tag data** ==
701 701  
702 702  (((
703 -**Parameters**
703 +**3.5.1 Parameters**
704 704  )))
705 705  
706 706  (% class="table-bordered" %)
... ... @@ -711,7 +711,7 @@
711 711  |value|value
712 712  |**Return value**|(% colspan="2" %)None
713 713  
714 -**Operating procedures**
714 +**3.5.2 Operating procedures**
715 715  
716 716  **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]]
717 717  
... ... @@ -740,7 +740,7 @@
740 740  (% style="text-align:center" %)
741 741  [[image:V-BOX HTTP manual_html_59d54a5d886ef614.png||height="244" width="700" class="img-thumbnail"]]
742 742  
743 -**Result**
743 +**3.5.3 Result**
744 744  
745 745  {
746 746  
... ... @@ -757,9 +757,9 @@
757 757  (% style="text-align:center" %)
758 758  [[image:V-BOX HTTP manual_html_590c8dab9e80fd0f.png||height="425" width="700" class="img-thumbnail"]]
759 759  
760 -== ** {{id name="_Toc24963751"/}}Historical tags name list** ==
760 +== **3.6 {{id name="_Toc24963751"/}}Historical tags name list** ==
761 761  
762 -**Parameters**
762 +**3.6.1 Parameters**
763 763  
764 764  (% class="table-bordered" %)
765 765  |**acturl**|(% colspan="3" %)we-data/monitors
... ... @@ -771,7 +771,7 @@
771 771  |monitorId|tag ID
772 772  |monitorName|tag name
773 773  
774 -**Operating procedures**
774 +**3.6.2 Operating procedures**
775 775  
776 776  **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]]
777 777  
... ... @@ -798,7 +798,7 @@
798 798  (% style="text-align:center" %)
799 799  [[image:V-BOX HTTP manual_html_dba52ac718eeb66e.png||height="228" width="700" class="img-thumbnail"]]
800 800  
801 -**Result**
801 +**3.6.3 Result**
802 802  
803 803  {
804 804  
... ... @@ -841,9 +841,9 @@
841 841  (% style="text-align:center" %)
842 842  [[image:V-BOX HTTP manual_html_2a739377a9fb10b2.png||height="400" width="700" class="img-thumbnail"]]
843 843  
844 -== ** {{id name="_Toc24963755"/}}Historical tag data list** ==
844 +== (% id="cke_bm_1218S" style="display:none" %)** **(%%)**3.7 {{id name="_Toc24963755"/}}Historical tag data list** ==
845 845  
846 -**~ {{id name="_Toc24963756"/}}Parameters**
846 +**3.7.1 {{id name="_Toc24963756"/}}Parameters**
847 847  
848 848  (% class="table-bordered" %)
849 849  |**acturl**|(% colspan="3" %)we-data/historydata
... ... @@ -863,7 +863,7 @@
863 863  |totalRecord|(% colspan="2" %)Total records
864 864  |currentPage|(% colspan="2" %)Current page
865 865  
866 -**Operating procedures**
866 +**3.7.2 Operating procedures**
867 867  
868 868  **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]]
869 869  
... ... @@ -898,7 +898,7 @@
898 898  (% style="text-align:center" %)
899 899  [[image:V-BOX HTTP manual_html_fac48b1179b555ee.png||height="291" width="700" class="img-thumbnail"]]
900 900  
901 -**Result**
901 +**3.7.3 Result**
902 902  
903 903  {
904 904  
... ... @@ -961,9 +961,9 @@
961 961  (% style="text-align:center" %)
962 962  [[image:V-BOX HTTP manual_html_f3b62eb69687a214.png||height="476" width="700" class="img-thumbnail"]]
963 963  
964 -== **Alarm tags data list** ==
964 +== **3.8 Alarm tags data list** ==
965 965  
966 -**{{id name="_Toc24963760"/}}Parameters**
966 +**​​​​​​​​​​​​​​3.8.1 {{id name="_Toc24963760"/}}Parameters**
967 967  
968 968  (% class="table-bordered" %)
969 969  |**acturl**|(% colspan="3" %)we-data/alarmdata
... ... @@ -998,7 +998,7 @@
998 998  |totalRecord|(% colspan="2" %)Total records
999 999  |currentPage|(% colspan="2" %)Current page
1000 1000  
1001 -**~ {{id name="_Toc24963761"/}}Operating procedures**
1001 +**​​​​​​​​​​​​​​3.8.2 {{id name="_Toc24963761"/}}Operating procedures**
1002 1002  
1003 1003  **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]]
1004 1004  
... ... @@ -1035,7 +1035,7 @@
1035 1035  (% style="text-align:center" %)
1036 1036  [[image:V-BOX HTTP manual_html_cd9ce84648b86cb9.png||height="269" width="700" class="img-thumbnail"]]
1037 1037  
1038 -**Result**
1038 +**3.8.3 Result**
1039 1039  
1040 1040  {
1041 1041  
... ... @@ -1114,9 +1114,9 @@
1114 1114  (% style="text-align:center" %)
1115 1115  [[image:V-BOX HTTP manual_html_d4a3e0114c402c27.png||height="475" width="700" class="img-thumbnail"]]
1116 1116  
1117 -== **Get device state** ==
1117 +== **3.9 Get device state** ==
1118 1118  
1119 -**~ {{id name="_Toc24963760"/}}Parameters**
1119 +**3.9.1 {{id name="_Toc24963760"/}}Parameters**
1120 1120  
1121 1121  (% class="table-bordered" %)
1122 1122  |**acturl**|(% colspan="3" %)we-data/getDeviceState
... ... @@ -1126,7 +1126,7 @@
1126 1126  |(% rowspan="2" %)**Return value**|Field name|(% colspan="2" %)Description
1127 1127  |state|(% colspan="2" %)vbox state: 1-online,  0-offline
1128 1128  
1129 -== **Send switch to device** ==
1129 +== **3.10 Send switch to device** ==
1130 1130  
1131 1131  **3.10.1 {{id name="_Toc24963760"/}}Parameters**
1132 1132  
... ... @@ -1137,9 +1137,9 @@
1137 1137  |(% style="width:450px" %)boxId|(% colspan="2" %)boxId(required)
1138 1138  |(% rowspan="1" style="width:102px" %)**Return value**|(% style="width:450px" %)Field name|(% colspan="2" %)Description
1139 1139  
1140 -= **Appendix** =
1140 += **4 Appendix** =
1141 1141  
1142 -== (% style="color:inherit; font-family:inherit; font-size:26px" %)**Data type**(%%) ==
1142 +== (% style="color:inherit; font-family:inherit; font-size:26px" %)**4.1 Data type**(%%) ==
1143 1143  
1144 1144  100: 16-bit binary
1145 1145