Skip to Content

Changes for page 07 HTTP API

Last modified by Devin Chen on 2025/04/10 16:16
From version 6.2
edited by Hunter
on 2022/07/25 11:33
Change comment: Update document after refactoring.
To version 4.1
edited by Hunter
on 2022/07/11 10:48
Change comment: There is no comment for this version

Summary

Details

Page properties
Parent
... ... @@ -1,1 +1,1 @@
1 -V-BOX.V-Net.WebHome
1 +V-BOX.V-Net.1\.User Manual.WebHome
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||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  
... ... @@ -43,16 +43,14 @@
43 43  
44 44  screctkey=f1cd9351930d4e589922edbcf3b09a7c
45 45  
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)
46 +== 1.1 Interface parameter description ==
47 47  
48 -== **1.1 Interface Parameter Description** ==
49 -
50 50  **Global parameters**
51 51  
52 52  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)
53 53  
54 54  (% style="text-align:center" %)
55 -[[image:企业微信截图_20210531172144.png||height="467" width="800" class="img-thumbnail"]]
53 +[[image:企业微信截图_20210531172144.png||class="img-thumbnail" height="467" width="800"]]
56 56  
57 57  **The returned result represented by Json and case sensitive:**
58 58  
... ... @@ -64,10 +64,10 @@
64 64  
65 65  {"code" : 200 , "result": {}, "msg" : "ok", "reqId":"1502074141465"}
66 66  
67 -**Status Code**
65 +**State code description**
68 68  
69 69  (% style="text-align:center" %)
70 -[[image:1.png||height="141" width="500" class="img-thumbnail"]]
68 +[[image:1.png||class="img-thumbnail" height="141" width="500"]]
71 71  
72 72  == **1.2 Example key and value** ==
73 73  
... ... @@ -89,16 +89,15 @@
89 89  **2.1.1 Parameters**
90 90  )))
91 91  
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
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
102 102  
103 103  **2.1.2 Operating procedures**
104 104  
... ... @@ -124,10 +124,6 @@
124 124  
125 125  "sign":"997513ff1320862f0cbb9ce19d0bd253"
126 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 -
131 131  **Step4: ** Set common of header
132 132  
133 133  {"comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"997513ff1320862f0cbb9ce19d0bd253"}
... ... @@ -171,7 +171,7 @@
171 171  **3.1.1 {{id name="_Toc24963732"/}}Parameters**
172 172  
173 173  (% style="text-align:center" %)
174 -[[image:X.png||height="412" width="700" class="img-thumbnail"]]
167 +[[image:X.png||class="img-thumbnail" height="412" width="700"]]
175 175  
176 176  **3.1.2 {{id name="_Toc24963733"/}}Operating procedures**
177 177  
... ... @@ -178,7 +178,7 @@
178 178  **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]]
179 179  
180 180  (% style="text-align:center" %)
181 -[[image:V-BOX HTTP manual_html_7555868f6d398292.png||height="48" width="700" class="img-thumbnail"]]
174 +[[image:V-BOX HTTP manual_html_7555868f6d398292.png||class="img-thumbnail" height="48" width="700"]]
182 182  
183 183  **Step2:**  Set parameters on Params
184 184  
... ... @@ -195,7 +195,7 @@
195 195  {"sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"8fb4fbf99fcc1331c3274e708a403034"}
196 196  
197 197  (% style="text-align:center" %)
198 -[[image:V-BOX HTTP manual_html_999832f3a31ac851.png||height="232" width="700" class="img-thumbnail"]]
191 +[[image:V-BOX HTTP manual_html_999832f3a31ac851.png||class="img-thumbnail" height="232" width="700"]]
199 199  
200 200  **3.1.3 Result**
201 201  
... ... @@ -324,7 +324,7 @@
324 324  }
325 325  
326 326  (% style="text-align:center" %)
327 -[[image:V-BOX HTTP manual_html_5999b14ed63e8065.png||height="348" width="600" class="img-thumbnail"]]
320 +[[image:V-BOX HTTP manual_html_5999b14ed63e8065.png||class="img-thumbnail" height="348" width="600"]]
328 328  
329 329  == **3.2 Real-time group list** ==
330 330  
... ... @@ -345,7 +345,7 @@
345 345  **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]]
346 346  
347 347  (% style="text-align:center" %)
348 -[[image:V-BOX HTTP manual_html_abb2159981171c6.png||height="46" width="700" class="img-thumbnail"]]
341 +[[image:V-BOX HTTP manual_html_abb2159981171c6.png||class="img-thumbnail" height="46" width="700"]]
349 349  
350 350  **Step2: **Set parameters on Params
351 351  
... ... @@ -352,7 +352,7 @@
352 352  "boxId": "973"
353 353  
354 354  (% style="text-align:center" %)
355 -[[image:V-BOX HTTP manual_html_5c3ab35ebdab144e.png||height="151" width="800" class="img-thumbnail"]]
348 +[[image:V-BOX HTTP manual_html_5c3ab35ebdab144e.png||class="img-thumbnail" height="151" width="800"]]
356 356  
357 357  **Step3: **Get sign
358 358  
... ... @@ -365,7 +365,7 @@
365 365  {"boxId":"973","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"9b267b7549083167954b7ede30916ff5"}
366 366  
367 367  (% style="text-align:center" %)
368 -[[image:V-BOX HTTP manual_html_cc06cac462c1b77a.png||height="172" width="800" class="img-thumbnail"]]
361 +[[image:V-BOX HTTP manual_html_cc06cac462c1b77a.png||class="img-thumbnail" height="172" width="800"]]
369 369  
370 370  **3.2.3 Result**
371 371  
... ... @@ -462,7 +462,7 @@
462 462  **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]]
463 463  
464 464  (% style="text-align:center" %)
465 -[[image:V-BOX HTTP manual_html_3fff373ae27e2e00.png||height="44" width="700" class="img-thumbnail"]]
458 +[[image:V-BOX HTTP manual_html_3fff373ae27e2e00.png||class="img-thumbnail" height="44" width="700"]]
466 466  
467 467  **Step2: **Set parameters on Params
468 468  
... ... @@ -475,7 +475,7 @@
475 475  "pageIndex":"2"
476 476  
477 477  (% style="text-align:center" %)
478 -[[image:V-BOX HTTP manual_html_52bf7d95165a3e3a.png||height="273" width="700" class="img-thumbnail"]]
471 +[[image:V-BOX HTTP manual_html_52bf7d95165a3e3a.png||class="img-thumbnail" height="273" width="700"]]
479 479  
480 480  **Step3:** Get sign
481 481  
... ... @@ -488,7 +488,7 @@
488 488  {"boxId":"973","groupId":"7325","pageSize":"5","pageIndex":"2","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"0769228e66c945eed5431c41a96949f2"}
489 489  
490 490  (% style="text-align:center" %)
491 -[[image:V-BOX HTTP manual_html_d284dfdd7b4844ee.png||height="288" width="800" class="img-thumbnail"]]
484 +[[image:V-BOX HTTP manual_html_d284dfdd7b4844ee.png||class="img-thumbnail" height="288" width="800"]]
492 492  
493 493  **3.3.3 Result**
494 494  
... ... @@ -571,7 +571,7 @@
571 571  }
572 572  
573 573  (% style="text-align:center" %)
574 -[[image:V-BOX HTTP manual_html_e7271097b71941cc.png||height="644" width="800" class="img-thumbnail"]]
567 +[[image:V-BOX HTTP manual_html_e7271097b71941cc.png||class="img-thumbnail" height="644" width="800"]]
575 575  
576 576  == (% id="cke_bm_1151S" style="display:none" %)** {{id name="_Toc24963743"/}}**(%%)**3.4 Tags data list** ==
577 577  
... ... @@ -602,7 +602,7 @@
602 602  **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]]
603 603  
604 604  (% style="text-align:center" %)
605 -[[image:V-BOX HTTP manual_html_839fb0577dac88c1.png||height="45" width="700" class="img-thumbnail"]]
598 +[[image:V-BOX HTTP manual_html_839fb0577dac88c1.png||class="img-thumbnail" height="45" width="700"]]
606 606  
607 607  **Step2: **Set parameters on Params
608 608  
... ... @@ -615,7 +615,7 @@
615 615  "pageIndex":"2"
616 616  
617 617  (% style="text-align:center" %)
618 -[[image:V-BOX HTTP manual_html_b860bab44ebbc128.png||height="272" width="700" class="img-thumbnail"]]
611 +[[image:V-BOX HTTP manual_html_b860bab44ebbc128.png||class="img-thumbnail" height="272" width="700"]]
619 619  
620 620  **Step3:** Get sign
621 621  
... ... @@ -688,7 +688,7 @@
688 688  }
689 689  
690 690  (% style="text-align:center" %)
691 -[[image:V-BOX HTTP manual_html_705682e81eae5ea7.png||height="651" width="800" class="img-thumbnail"]]
684 +[[image:V-BOX HTTP manual_html_705682e81eae5ea7.png||class="img-thumbnail" height="651" width="800"]]
692 692  
693 693  == **3.5 Modify tag data** ==
694 694  
... ... @@ -709,7 +709,7 @@
709 709  **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]]
710 710  
711 711  (% style="text-align:center" %)
712 -[[image:1651915094120-525.png||height="45" width="700" class="img-thumbnail"]]
705 +[[image:1651915094120-525.png||class="img-thumbnail" height="45" width="700"]]
713 713  
714 714  **Step2:** Set parameters on Params
715 715  
... ... @@ -718,7 +718,7 @@
718 718  "value":"60"
719 719  
720 720  (% style="text-align:center" %)
721 -[[image:V-BOX HTTP manual_html_5a3153add75ca7b4.png||height="246" width="800" class="img-thumbnail"]]
714 +[[image:V-BOX HTTP manual_html_5a3153add75ca7b4.png||class="img-thumbnail" height="246" width="800"]]
722 722  
723 723  **Step3:** Get sign
724 724  
... ... @@ -731,7 +731,7 @@
731 731  {"monitorId":"91541","value":"60","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"4119b1abc9176a187f781bece04a5296"}
732 732  
733 733  (% style="text-align:center" %)
734 -[[image:V-BOX HTTP manual_html_59d54a5d886ef614.png||height="244" width="700" class="img-thumbnail"]]
727 +[[image:V-BOX HTTP manual_html_59d54a5d886ef614.png||class="img-thumbnail" height="244" width="700"]]
735 735  
736 736  **3.5.3 Result**
737 737  
... ... @@ -748,7 +748,7 @@
748 748  }
749 749  
750 750  (% style="text-align:center" %)
751 -[[image:V-BOX HTTP manual_html_590c8dab9e80fd0f.png||height="425" width="700" class="img-thumbnail"]]
744 +[[image:V-BOX HTTP manual_html_590c8dab9e80fd0f.png||class="img-thumbnail" height="425" width="700"]]
752 752  
753 753  == **3.6 {{id name="_Toc24963751"/}}Historical tags name list** ==
754 754  
... ... @@ -764,12 +764,12 @@
764 764  |monitorId|tag ID
765 765  |monitorName|tag name
766 766  
767 -**3.6.2 Operating procedures**
760 +**​​​​​​​3.6.2 Operating procedures**
768 768  
769 769  **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]]
770 770  
771 771  (% style="text-align:center" %)
772 -[[image:V-BOX HTTP manual_html_456f00c6af3ea1b7.png||height="45" width="700" class="img-thumbnail"]]
765 +[[image:V-BOX HTTP manual_html_456f00c6af3ea1b7.png||class="img-thumbnail" height="45" width="700"]]
773 773  
774 774  **Step2: **Set parameters on Params
775 775  
... ... @@ -776,7 +776,7 @@
776 776  "boxId":"973"
777 777  
778 778  (% style="text-align:center" %)
779 -[[image:V-BOX HTTP manual_html_8bf7c3f9b3ce3897.png||height="185" width="700" class="img-thumbnail"]]
772 +[[image:V-BOX HTTP manual_html_8bf7c3f9b3ce3897.png||class="img-thumbnail" height="185" width="700"]]
780 780  
781 781  **Step3:** Get sign
782 782  
... ... @@ -789,7 +789,7 @@
789 789  {"boxId":"973","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"9b267b7549083167954b7ede30916ff5"}
790 790  
791 791  (% style="text-align:center" %)
792 -[[image:V-BOX HTTP manual_html_dba52ac718eeb66e.png||height="228" width="700" class="img-thumbnail"]]
785 +[[image:V-BOX HTTP manual_html_dba52ac718eeb66e.png||class="img-thumbnail" height="228" width="700"]]
793 793  
794 794  **​​​​​​​3.6.3 Result**
795 795  
... ... @@ -832,7 +832,7 @@
832 832  }
833 833  
834 834  (% style="text-align:center" %)
835 -[[image:V-BOX HTTP manual_html_2a739377a9fb10b2.png||height="400" width="700" class="img-thumbnail"]]
828 +[[image:V-BOX HTTP manual_html_2a739377a9fb10b2.png||class="img-thumbnail" height="400" width="700"]]
836 836  
837 837  == (% id="cke_bm_1218S" style="display:none" %)** **(%%)**3.7 {{id name="_Toc24963755"/}}Historical tag data list** ==
838 838  
... ... @@ -861,7 +861,7 @@
861 861  **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]]
862 862  
863 863  (% style="text-align:center" %)
864 -[[image:V-BOX HTTP manual_html_cd2fdea1493dc20e.png||height="47" width="700" class="img-thumbnail"]]
857 +[[image:V-BOX HTTP manual_html_cd2fdea1493dc20e.png||class="img-thumbnail" height="47" width="700"]]
865 865  
866 866  **Step2:** Set parameters on Params
867 867  
... ... @@ -876,7 +876,7 @@
876 876  "pageIndex":"2"
877 877  
878 878  (% style="text-align:center" %)
879 -[[image:V-BOX HTTP manual_html_f169ff87c20ce6c4.png||height="302" width="700" class="img-thumbnail"]]
872 +[[image:V-BOX HTTP manual_html_f169ff87c20ce6c4.png||class="img-thumbnail" height="302" width="700"]]
880 880  
881 881  **Step3: **Get sign
882 882  
... ... @@ -889,7 +889,7 @@
889 889  {"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"}
890 890  
891 891  (% style="text-align:center" %)
892 -[[image:V-BOX HTTP manual_html_fac48b1179b555ee.png||height="291" width="700" class="img-thumbnail"]]
885 +[[image:V-BOX HTTP manual_html_fac48b1179b555ee.png||class="img-thumbnail" height="291" width="700"]]
893 893  
894 894  **3.7.3 Result**
895 895  
... ... @@ -952,7 +952,7 @@
952 952  }
953 953  
954 954  (% style="text-align:center" %)
955 -[[image:V-BOX HTTP manual_html_f3b62eb69687a214.png||height="476" width="700" class="img-thumbnail"]]
948 +[[image:V-BOX HTTP manual_html_f3b62eb69687a214.png||class="img-thumbnail" height="476" width="700"]]
956 956  
957 957  == **3.8 Alarm tags data list** ==
958 958  
... ... @@ -996,7 +996,7 @@
996 996  **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]]
997 997  
998 998  (% style="text-align:center" %)
999 -[[image:V-BOX HTTP manual_html_4ebee4d4fcf0097c.png||height="45" width="700" class="img-thumbnail"]]
992 +[[image:V-BOX HTTP manual_html_4ebee4d4fcf0097c.png||class="img-thumbnail" height="45" width="700"]]
1000 1000  
1001 1001  **Step2:** Set parameters on Params
1002 1002  
... ... @@ -1013,7 +1013,7 @@
1013 1013  "state":"2"
1014 1014  
1015 1015  (% style="text-align:center" %)
1016 -[[image:V-BOX HTTP manual_html_2361d0eaa7447a9c.png||height="327" width="700" class="img-thumbnail"]]
1009 +[[image:V-BOX HTTP manual_html_2361d0eaa7447a9c.png||class="img-thumbnail" height="327" width="700"]]
1017 1017  
1018 1018  **Step3:** Get sign
1019 1019  
... ... @@ -1026,7 +1026,7 @@
1026 1026  {"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"}
1027 1027  
1028 1028  (% style="text-align:center" %)
1029 -[[image:V-BOX HTTP manual_html_cd9ce84648b86cb9.png||height="269" width="700" class="img-thumbnail"]]
1022 +[[image:V-BOX HTTP manual_html_cd9ce84648b86cb9.png||class="img-thumbnail" height="269" width="700"]]
1030 1030  
1031 1031  **3.8.3 Result**
1032 1032  
... ... @@ -1105,7 +1105,7 @@
1105 1105  }
1106 1106  
1107 1107  (% style="text-align:center" %)
1108 -[[image:V-BOX HTTP manual_html_d4a3e0114c402c27.png||height="475" width="700" class="img-thumbnail"]]
1101 +[[image:V-BOX HTTP manual_html_d4a3e0114c402c27.png||class="img-thumbnail" height="475" width="700"]]
1109 1109  
1110 1110  == **3.9 Get device state** ==
1111 1111