Skip to Content

Changes for page 07 HTTP API

Last modified by Devin Chen on 2025/04/10 16:16
From version 3.1
edited by Hunter
on 2022/07/11 10:41
Change comment: There is no comment for this version
To version 5.1
edited by Hunter
on 2022/07/13 12:04
Change comment: There is no comment for this version

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|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
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  
... ... @@ -108,7 +108,7 @@
108 108  
109 109   alias: weconuser
110 110  
111 - password: 599a3c736c04e196c58a29f43778f7ea(Wecon159)
114 + password: 599a3c736c04e196c58a29f43778f7ea(The md5 encryption result of Wecon159)
112 112  
113 113  (% style="text-align:center" %)
114 114  [[image:V-BOX HTTP manual_html_563261d83c8f3530.png||height="250" width="700" class="img-thumbnail"]]
... ... @@ -117,8 +117,14 @@
117 117  
118 118  alias=weconuser&comid=2&compvtkey=589625dce895454dbff9782c299db156&password=599a3c736c04e196c58a29f43778f7ea&ts=1573897380&key=f1cd9351930d4e589922edbcf3b09a7c
119 119  
120 -MD5 value: 997513ff1320862f0cbb9ce19d0bd253
123 +Put the whole string above encrypted by MD5, so will get the value of "sign"
121 121  
125 +"sign":"997513ff1320862f0cbb9ce19d0bd253"
126 +
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 +
122 122  **Step4: ** Set common of header
123 123  
124 124  {"comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"997513ff1320862f0cbb9ce19d0bd253"}
... ... @@ -162,7 +162,7 @@
162 162  **3.1.1 {{id name="_Toc24963732"/}}Parameters**
163 163  
164 164  (% style="text-align:center" %)
165 -[[image:X.png||class="img-thumbnail" height="412" width="700"]]
174 +[[image:X.png||height="412" width="700" class="img-thumbnail"]]
166 166  
167 167  **3.1.2 {{id name="_Toc24963733"/}}Operating procedures**
168 168  
... ... @@ -169,7 +169,7 @@
169 169  **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]]
170 170  
171 171  (% style="text-align:center" %)
172 -[[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"]]
173 173  
174 174  **Step2:**  Set parameters on Params
175 175  
... ... @@ -186,7 +186,7 @@
186 186  {"sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"8fb4fbf99fcc1331c3274e708a403034"}
187 187  
188 188  (% style="text-align:center" %)
189 -[[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"]]
190 190  
191 191  **3.1.3 Result**
192 192  
... ... @@ -315,7 +315,7 @@
315 315  }
316 316  
317 317  (% style="text-align:center" %)
318 -[[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"]]
319 319  
320 320  == **3.2 Real-time group list** ==
321 321  
... ... @@ -336,7 +336,7 @@
336 336  **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]]
337 337  
338 338  (% style="text-align:center" %)
339 -[[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"]]
340 340  
341 341  **Step2: **Set parameters on Params
342 342  
... ... @@ -343,7 +343,7 @@
343 343  "boxId": "973"
344 344  
345 345  (% style="text-align:center" %)
346 -[[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"]]
347 347  
348 348  **Step3: **Get sign
349 349  
... ... @@ -356,7 +356,7 @@
356 356  {"boxId":"973","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"9b267b7549083167954b7ede30916ff5"}
357 357  
358 358  (% style="text-align:center" %)
359 -[[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"]]
360 360  
361 361  **3.2.3 Result**
362 362  
... ... @@ -453,7 +453,7 @@
453 453  **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]]
454 454  
455 455  (% style="text-align:center" %)
456 -[[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"]]
457 457  
458 458  **Step2: **Set parameters on Params
459 459  
... ... @@ -466,7 +466,7 @@
466 466  "pageIndex":"2"
467 467  
468 468  (% style="text-align:center" %)
469 -[[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"]]
470 470  
471 471  **Step3:** Get sign
472 472  
... ... @@ -479,7 +479,7 @@
479 479  {"boxId":"973","groupId":"7325","pageSize":"5","pageIndex":"2","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"0769228e66c945eed5431c41a96949f2"}
480 480  
481 481  (% style="text-align:center" %)
482 -[[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"]]
483 483  
484 484  **3.3.3 Result**
485 485  
... ... @@ -562,7 +562,7 @@
562 562  }
563 563  
564 564  (% style="text-align:center" %)
565 -[[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"]]
566 566  
567 567  == (% id="cke_bm_1151S" style="display:none" %)** {{id name="_Toc24963743"/}}**(%%)**3.4 Tags data list** ==
568 568  
... ... @@ -593,7 +593,7 @@
593 593  **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]]
594 594  
595 595  (% style="text-align:center" %)
596 -[[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"]]
597 597  
598 598  **Step2: **Set parameters on Params
599 599  
... ... @@ -606,7 +606,7 @@
606 606  "pageIndex":"2"
607 607  
608 608  (% style="text-align:center" %)
609 -[[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"]]
610 610  
611 611  **Step3:** Get sign
612 612  
... ... @@ -679,7 +679,7 @@
679 679  }
680 680  
681 681  (% style="text-align:center" %)
682 -[[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"]]
683 683  
684 684  == **3.5 Modify tag data** ==
685 685  
... ... @@ -700,7 +700,7 @@
700 700  **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]]
701 701  
702 702  (% style="text-align:center" %)
703 -[[image:1651915094120-525.png||class="img-thumbnail" height="45" width="700"]]
712 +[[image:1651915094120-525.png||height="45" width="700" class="img-thumbnail"]]
704 704  
705 705  **Step2:** Set parameters on Params
706 706  
... ... @@ -709,7 +709,7 @@
709 709  "value":"60"
710 710  
711 711  (% style="text-align:center" %)
712 -[[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"]]
713 713  
714 714  **Step3:** Get sign
715 715  
... ... @@ -722,7 +722,7 @@
722 722  {"monitorId":"91541","value":"60","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"4119b1abc9176a187f781bece04a5296"}
723 723  
724 724  (% style="text-align:center" %)
725 -[[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"]]
726 726  
727 727  **3.5.3 Result**
728 728  
... ... @@ -739,7 +739,7 @@
739 739  }
740 740  
741 741  (% style="text-align:center" %)
742 -[[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"]]
743 743  
744 744  == **3.6 {{id name="_Toc24963751"/}}Historical tags name list** ==
745 745  
... ... @@ -755,12 +755,12 @@
755 755  |monitorId|tag ID
756 756  |monitorName|tag name
757 757  
758 -**​​​​​​​3.6.2 Operating procedures**
767 +**3.6.2 Operating procedures**
759 759  
760 760  **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]]
761 761  
762 762  (% style="text-align:center" %)
763 -[[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"]]
764 764  
765 765  **Step2: **Set parameters on Params
766 766  
... ... @@ -767,7 +767,7 @@
767 767  "boxId":"973"
768 768  
769 769  (% style="text-align:center" %)
770 -[[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"]]
771 771  
772 772  **Step3:** Get sign
773 773  
... ... @@ -780,7 +780,7 @@
780 780  {"boxId":"973","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"9b267b7549083167954b7ede30916ff5"}
781 781  
782 782  (% style="text-align:center" %)
783 -[[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"]]
784 784  
785 785  **​​​​​​​3.6.3 Result**
786 786  
... ... @@ -823,7 +823,7 @@
823 823  }
824 824  
825 825  (% style="text-align:center" %)
826 -[[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"]]
827 827  
828 828  == (% id="cke_bm_1218S" style="display:none" %)** **(%%)**3.7 {{id name="_Toc24963755"/}}Historical tag data list** ==
829 829  
... ... @@ -852,7 +852,7 @@
852 852  **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]]
853 853  
854 854  (% style="text-align:center" %)
855 -[[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"]]
856 856  
857 857  **Step2:** Set parameters on Params
858 858  
... ... @@ -867,7 +867,7 @@
867 867  "pageIndex":"2"
868 868  
869 869  (% style="text-align:center" %)
870 -[[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"]]
871 871  
872 872  **Step3: **Get sign
873 873  
... ... @@ -880,7 +880,7 @@
880 880  {"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"}
881 881  
882 882  (% style="text-align:center" %)
883 -[[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"]]
884 884  
885 885  **3.7.3 Result**
886 886  
... ... @@ -943,7 +943,7 @@
943 943  }
944 944  
945 945  (% style="text-align:center" %)
946 -[[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"]]
947 947  
948 948  == **3.8 Alarm tags data list** ==
949 949  
... ... @@ -987,7 +987,7 @@
987 987  **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]]
988 988  
989 989  (% style="text-align:center" %)
990 -[[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"]]
991 991  
992 992  **Step2:** Set parameters on Params
993 993  
... ... @@ -1004,7 +1004,7 @@
1004 1004  "state":"2"
1005 1005  
1006 1006  (% style="text-align:center" %)
1007 -[[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"]]
1008 1008  
1009 1009  **Step3:** Get sign
1010 1010  
... ... @@ -1017,7 +1017,7 @@
1017 1017  {"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"}
1018 1018  
1019 1019  (% style="text-align:center" %)
1020 -[[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"]]
1021 1021  
1022 1022  **3.8.3 Result**
1023 1023  
... ... @@ -1096,7 +1096,7 @@
1096 1096  }
1097 1097  
1098 1098  (% style="text-align:center" %)
1099 -[[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"]]
1100 1100  
1101 1101  == **3.9 Get device state** ==
1102 1102