Skip to Content

Changes for page 07 HTTP API

Last modified by Devin Chen on 2025/04/10 16:16
From version 4.1
edited by Hunter
on 2022/07/11 10:48
Change comment: There is no comment for this version
To version 6.1
edited by Hunter
on 2022/07/25 11:33
Change comment: Renamed from xwiki:V-BOX.V-Net.1\.User Manual.05 HTTP API.WebHome

Summary

Details

Page properties
Content
... ... @@ -19,7 +19,7 @@
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||class="img-thumbnail" height="361" width="800"]]
22 +[[image:V-BOX HTTP manual_html_ceb1e13ef4c1fa5d.png||height="361" width="800" class="img-thumbnail"]]
23 23  
24 24  For **ASEAN server** V-BOX, now can use http, the server address is api.asean.v-box.net.
25 25  
... ... @@ -43,14 +43,16 @@
43 43  
44 44  screctkey=f1cd9351930d4e589922edbcf3b09a7c
45 45  
46 -== 1.1 Interface parameter description ==
46 +**✎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)
47 47  
48 +== **1.1 Interface Parameter Description** ==
49 +
48 48  **Global parameters**
49 49  
50 50  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)
51 51  
52 52  (% style="text-align:center" %)
53 -[[image:企业微信截图_20210531172144.png||class="img-thumbnail" height="467" width="800"]]
55 +[[image:企业微信截图_20210531172144.png||height="467" width="800" class="img-thumbnail"]]
54 54  
55 55  **The returned result represented by Json and case sensitive:**
56 56  
... ... @@ -62,10 +62,10 @@
62 62  
63 63  {"code" : 200 , "result": {}, "msg" : "ok", "reqId":"1502074141465"}
64 64  
65 -**State code description**
67 +**Status Code**
66 66  
67 67  (% style="text-align:center" %)
68 -[[image:1.png||class="img-thumbnail" height="141" width="500"]]
70 +[[image:1.png||height="141" width="500" class="img-thumbnail"]]
69 69  
70 70  == **1.2 Example key and value** ==
71 71  
... ... @@ -87,15 +87,16 @@
87 87  **2.1.1 Parameters**
88 88  )))
89 89  
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|32bit password (MD5 encryption)
96 -|(% rowspan="3" %)**Return value**|Items|Description
97 -|utype|User Type: 1-Manage Account, 2-Viewer Account
98 -|sid|User session ID
92 +(% class="table-bordered" style="width:888px" %)
93 +|**Acturl**|(% colspan="2" style="width:731px" %)we-data/login
94 +|**Function**|(% colspan="2" style="width:731px" %)Login with username, email, phone number
95 +|(% colspan="1" rowspan="4" %)**Parameters**|Items|(% style="width:535px" %)Description
96 +|alias|(% style="width:535px" %)Username, email, phone number
97 +|password|(% style="width:535px" %)32bit password (MD5 encryption)
98 +|domain(Optional)|(% style="width:535px" %)3rd party interface domain(Only available for Virtual Deployment)
99 +|(% rowspan="3" %)**Return value**|Items|(% style="width:535px" %)Description
100 +|utype|(% style="width:535px" %)User Type: 1-Manage Account, 2-Viewer Account
101 +|sid|(% style="width:535px" %)User session ID
99 99  
100 100  **2.1.2 Operating procedures**
101 101  
... ... @@ -121,6 +121,10 @@
121 121  
122 122  "sign":"997513ff1320862f0cbb9ce19d0bd253"
123 123  
127 +**✎Note: **For Virtual Deployment, the sign string should be append with domain, so the format would be like following:
128 +
129 +alias=xxx&comid=xxx&compvtkey=xxx&domain=xxx&password=xxx&ts=1657682972386&key=f1cd9351930d4e589922edbcf3b09a7c
130 +
124 124  **Step4: ** Set common of header
125 125  
126 126  {"comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"997513ff1320862f0cbb9ce19d0bd253"}
... ... @@ -164,7 +164,7 @@
164 164  **3.1.1 {{id name="_Toc24963732"/}}Parameters**
165 165  
166 166  (% style="text-align:center" %)
167 -[[image:X.png||class="img-thumbnail" height="412" width="700"]]
174 +[[image:X.png||height="412" width="700" class="img-thumbnail"]]
168 168  
169 169  **3.1.2 {{id name="_Toc24963733"/}}Operating procedures**
170 170  
... ... @@ -171,7 +171,7 @@
171 171  **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]]
172 172  
173 173  (% style="text-align:center" %)
174 -[[image:V-BOX HTTP manual_html_7555868f6d398292.png||class="img-thumbnail" height="48" width="700"]]
181 +[[image:V-BOX HTTP manual_html_7555868f6d398292.png||height="48" width="700" class="img-thumbnail"]]
175 175  
176 176  **Step2:**  Set parameters on Params
177 177  
... ... @@ -188,7 +188,7 @@
188 188  {"sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"8fb4fbf99fcc1331c3274e708a403034"}
189 189  
190 190  (% style="text-align:center" %)
191 -[[image:V-BOX HTTP manual_html_999832f3a31ac851.png||class="img-thumbnail" height="232" width="700"]]
198 +[[image:V-BOX HTTP manual_html_999832f3a31ac851.png||height="232" width="700" class="img-thumbnail"]]
192 192  
193 193  **3.1.3 Result**
194 194  
... ... @@ -317,7 +317,7 @@
317 317  }
318 318  
319 319  (% style="text-align:center" %)
320 -[[image:V-BOX HTTP manual_html_5999b14ed63e8065.png||class="img-thumbnail" height="348" width="600"]]
327 +[[image:V-BOX HTTP manual_html_5999b14ed63e8065.png||height="348" width="600" class="img-thumbnail"]]
321 321  
322 322  == **3.2 Real-time group list** ==
323 323  
... ... @@ -338,7 +338,7 @@
338 338  **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]]
339 339  
340 340  (% style="text-align:center" %)
341 -[[image:V-BOX HTTP manual_html_abb2159981171c6.png||class="img-thumbnail" height="46" width="700"]]
348 +[[image:V-BOX HTTP manual_html_abb2159981171c6.png||height="46" width="700" class="img-thumbnail"]]
342 342  
343 343  **Step2: **Set parameters on Params
344 344  
... ... @@ -345,7 +345,7 @@
345 345  "boxId": "973"
346 346  
347 347  (% style="text-align:center" %)
348 -[[image:V-BOX HTTP manual_html_5c3ab35ebdab144e.png||class="img-thumbnail" height="151" width="800"]]
355 +[[image:V-BOX HTTP manual_html_5c3ab35ebdab144e.png||height="151" width="800" class="img-thumbnail"]]
349 349  
350 350  **Step3: **Get sign
351 351  
... ... @@ -358,7 +358,7 @@
358 358  {"boxId":"973","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"9b267b7549083167954b7ede30916ff5"}
359 359  
360 360  (% style="text-align:center" %)
361 -[[image:V-BOX HTTP manual_html_cc06cac462c1b77a.png||class="img-thumbnail" height="172" width="800"]]
368 +[[image:V-BOX HTTP manual_html_cc06cac462c1b77a.png||height="172" width="800" class="img-thumbnail"]]
362 362  
363 363  **3.2.3 Result**
364 364  
... ... @@ -455,7 +455,7 @@
455 455  **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]]
456 456  
457 457  (% style="text-align:center" %)
458 -[[image:V-BOX HTTP manual_html_3fff373ae27e2e00.png||class="img-thumbnail" height="44" width="700"]]
465 +[[image:V-BOX HTTP manual_html_3fff373ae27e2e00.png||height="44" width="700" class="img-thumbnail"]]
459 459  
460 460  **Step2: **Set parameters on Params
461 461  
... ... @@ -468,7 +468,7 @@
468 468  "pageIndex":"2"
469 469  
470 470  (% style="text-align:center" %)
471 -[[image:V-BOX HTTP manual_html_52bf7d95165a3e3a.png||class="img-thumbnail" height="273" width="700"]]
478 +[[image:V-BOX HTTP manual_html_52bf7d95165a3e3a.png||height="273" width="700" class="img-thumbnail"]]
472 472  
473 473  **Step3:** Get sign
474 474  
... ... @@ -481,7 +481,7 @@
481 481  {"boxId":"973","groupId":"7325","pageSize":"5","pageIndex":"2","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"0769228e66c945eed5431c41a96949f2"}
482 482  
483 483  (% style="text-align:center" %)
484 -[[image:V-BOX HTTP manual_html_d284dfdd7b4844ee.png||class="img-thumbnail" height="288" width="800"]]
491 +[[image:V-BOX HTTP manual_html_d284dfdd7b4844ee.png||height="288" width="800" class="img-thumbnail"]]
485 485  
486 486  **3.3.3 Result**
487 487  
... ... @@ -564,7 +564,7 @@
564 564  }
565 565  
566 566  (% style="text-align:center" %)
567 -[[image:V-BOX HTTP manual_html_e7271097b71941cc.png||class="img-thumbnail" height="644" width="800"]]
574 +[[image:V-BOX HTTP manual_html_e7271097b71941cc.png||height="644" width="800" class="img-thumbnail"]]
568 568  
569 569  == (% id="cke_bm_1151S" style="display:none" %)** {{id name="_Toc24963743"/}}**(%%)**3.4 Tags data list** ==
570 570  
... ... @@ -595,7 +595,7 @@
595 595  **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]]
596 596  
597 597  (% style="text-align:center" %)
598 -[[image:V-BOX HTTP manual_html_839fb0577dac88c1.png||class="img-thumbnail" height="45" width="700"]]
605 +[[image:V-BOX HTTP manual_html_839fb0577dac88c1.png||height="45" width="700" class="img-thumbnail"]]
599 599  
600 600  **Step2: **Set parameters on Params
601 601  
... ... @@ -608,7 +608,7 @@
608 608  "pageIndex":"2"
609 609  
610 610  (% style="text-align:center" %)
611 -[[image:V-BOX HTTP manual_html_b860bab44ebbc128.png||class="img-thumbnail" height="272" width="700"]]
618 +[[image:V-BOX HTTP manual_html_b860bab44ebbc128.png||height="272" width="700" class="img-thumbnail"]]
612 612  
613 613  **Step3:** Get sign
614 614  
... ... @@ -681,7 +681,7 @@
681 681  }
682 682  
683 683  (% style="text-align:center" %)
684 -[[image:V-BOX HTTP manual_html_705682e81eae5ea7.png||class="img-thumbnail" height="651" width="800"]]
691 +[[image:V-BOX HTTP manual_html_705682e81eae5ea7.png||height="651" width="800" class="img-thumbnail"]]
685 685  
686 686  == **3.5 Modify tag data** ==
687 687  
... ... @@ -702,7 +702,7 @@
702 702  **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]]
703 703  
704 704  (% style="text-align:center" %)
705 -[[image:1651915094120-525.png||class="img-thumbnail" height="45" width="700"]]
712 +[[image:1651915094120-525.png||height="45" width="700" class="img-thumbnail"]]
706 706  
707 707  **Step2:** Set parameters on Params
708 708  
... ... @@ -711,7 +711,7 @@
711 711  "value":"60"
712 712  
713 713  (% style="text-align:center" %)
714 -[[image:V-BOX HTTP manual_html_5a3153add75ca7b4.png||class="img-thumbnail" height="246" width="800"]]
721 +[[image:V-BOX HTTP manual_html_5a3153add75ca7b4.png||height="246" width="800" class="img-thumbnail"]]
715 715  
716 716  **Step3:** Get sign
717 717  
... ... @@ -724,7 +724,7 @@
724 724  {"monitorId":"91541","value":"60","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"4119b1abc9176a187f781bece04a5296"}
725 725  
726 726  (% style="text-align:center" %)
727 -[[image:V-BOX HTTP manual_html_59d54a5d886ef614.png||class="img-thumbnail" height="244" width="700"]]
734 +[[image:V-BOX HTTP manual_html_59d54a5d886ef614.png||height="244" width="700" class="img-thumbnail"]]
728 728  
729 729  **3.5.3 Result**
730 730  
... ... @@ -741,7 +741,7 @@
741 741  }
742 742  
743 743  (% style="text-align:center" %)
744 -[[image:V-BOX HTTP manual_html_590c8dab9e80fd0f.png||class="img-thumbnail" height="425" width="700"]]
751 +[[image:V-BOX HTTP manual_html_590c8dab9e80fd0f.png||height="425" width="700" class="img-thumbnail"]]
745 745  
746 746  == **3.6 {{id name="_Toc24963751"/}}Historical tags name list** ==
747 747  
... ... @@ -757,12 +757,12 @@
757 757  |monitorId|tag ID
758 758  |monitorName|tag name
759 759  
760 -**​​​​​​​3.6.2 Operating procedures**
767 +**3.6.2 Operating procedures**
761 761  
762 762  **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]]
763 763  
764 764  (% style="text-align:center" %)
765 -[[image:V-BOX HTTP manual_html_456f00c6af3ea1b7.png||class="img-thumbnail" height="45" width="700"]]
772 +[[image:V-BOX HTTP manual_html_456f00c6af3ea1b7.png||height="45" width="700" class="img-thumbnail"]]
766 766  
767 767  **Step2: **Set parameters on Params
768 768  
... ... @@ -769,7 +769,7 @@
769 769  "boxId":"973"
770 770  
771 771  (% style="text-align:center" %)
772 -[[image:V-BOX HTTP manual_html_8bf7c3f9b3ce3897.png||class="img-thumbnail" height="185" width="700"]]
779 +[[image:V-BOX HTTP manual_html_8bf7c3f9b3ce3897.png||height="185" width="700" class="img-thumbnail"]]
773 773  
774 774  **Step3:** Get sign
775 775  
... ... @@ -782,7 +782,7 @@
782 782  {"boxId":"973","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"9b267b7549083167954b7ede30916ff5"}
783 783  
784 784  (% style="text-align:center" %)
785 -[[image:V-BOX HTTP manual_html_dba52ac718eeb66e.png||class="img-thumbnail" height="228" width="700"]]
792 +[[image:V-BOX HTTP manual_html_dba52ac718eeb66e.png||height="228" width="700" class="img-thumbnail"]]
786 786  
787 787  **​​​​​​​3.6.3 Result**
788 788  
... ... @@ -825,7 +825,7 @@
825 825  }
826 826  
827 827  (% style="text-align:center" %)
828 -[[image:V-BOX HTTP manual_html_2a739377a9fb10b2.png||class="img-thumbnail" height="400" width="700"]]
835 +[[image:V-BOX HTTP manual_html_2a739377a9fb10b2.png||height="400" width="700" class="img-thumbnail"]]
829 829  
830 830  == (% id="cke_bm_1218S" style="display:none" %)** **(%%)**3.7 {{id name="_Toc24963755"/}}Historical tag data list** ==
831 831  
... ... @@ -854,7 +854,7 @@
854 854  **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]]
855 855  
856 856  (% style="text-align:center" %)
857 -[[image:V-BOX HTTP manual_html_cd2fdea1493dc20e.png||class="img-thumbnail" height="47" width="700"]]
864 +[[image:V-BOX HTTP manual_html_cd2fdea1493dc20e.png||height="47" width="700" class="img-thumbnail"]]
858 858  
859 859  **Step2:** Set parameters on Params
860 860  
... ... @@ -869,7 +869,7 @@
869 869  "pageIndex":"2"
870 870  
871 871  (% style="text-align:center" %)
872 -[[image:V-BOX HTTP manual_html_f169ff87c20ce6c4.png||class="img-thumbnail" height="302" width="700"]]
879 +[[image:V-BOX HTTP manual_html_f169ff87c20ce6c4.png||height="302" width="700" class="img-thumbnail"]]
873 873  
874 874  **Step3: **Get sign
875 875  
... ... @@ -882,7 +882,7 @@
882 882  {"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"}
883 883  
884 884  (% style="text-align:center" %)
885 -[[image:V-BOX HTTP manual_html_fac48b1179b555ee.png||class="img-thumbnail" height="291" width="700"]]
892 +[[image:V-BOX HTTP manual_html_fac48b1179b555ee.png||height="291" width="700" class="img-thumbnail"]]
886 886  
887 887  **3.7.3 Result**
888 888  
... ... @@ -945,7 +945,7 @@
945 945  }
946 946  
947 947  (% style="text-align:center" %)
948 -[[image:V-BOX HTTP manual_html_f3b62eb69687a214.png||class="img-thumbnail" height="476" width="700"]]
955 +[[image:V-BOX HTTP manual_html_f3b62eb69687a214.png||height="476" width="700" class="img-thumbnail"]]
949 949  
950 950  == **3.8 Alarm tags data list** ==
951 951  
... ... @@ -989,7 +989,7 @@
989 989  **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]]
990 990  
991 991  (% style="text-align:center" %)
992 -[[image:V-BOX HTTP manual_html_4ebee4d4fcf0097c.png||class="img-thumbnail" height="45" width="700"]]
999 +[[image:V-BOX HTTP manual_html_4ebee4d4fcf0097c.png||height="45" width="700" class="img-thumbnail"]]
993 993  
994 994  **Step2:** Set parameters on Params
995 995  
... ... @@ -1006,7 +1006,7 @@
1006 1006  "state":"2"
1007 1007  
1008 1008  (% style="text-align:center" %)
1009 -[[image:V-BOX HTTP manual_html_2361d0eaa7447a9c.png||class="img-thumbnail" height="327" width="700"]]
1016 +[[image:V-BOX HTTP manual_html_2361d0eaa7447a9c.png||height="327" width="700" class="img-thumbnail"]]
1010 1010  
1011 1011  **Step3:** Get sign
1012 1012  
... ... @@ -1019,7 +1019,7 @@
1019 1019  {"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"}
1020 1020  
1021 1021  (% style="text-align:center" %)
1022 -[[image:V-BOX HTTP manual_html_cd9ce84648b86cb9.png||class="img-thumbnail" height="269" width="700"]]
1029 +[[image:V-BOX HTTP manual_html_cd9ce84648b86cb9.png||height="269" width="700" class="img-thumbnail"]]
1023 1023  
1024 1024  **3.8.3 Result**
1025 1025  
... ... @@ -1098,7 +1098,7 @@
1098 1098  }
1099 1099  
1100 1100  (% style="text-align:center" %)
1101 -[[image:V-BOX HTTP manual_html_d4a3e0114c402c27.png||class="img-thumbnail" height="475" width="700"]]
1108 +[[image:V-BOX HTTP manual_html_d4a3e0114c402c27.png||height="475" width="700" class="img-thumbnail"]]
1102 1102  
1103 1103  == **3.9 Get device state** ==
1104 1104