Skip to Content

Changes for page 07 HTTP API

Last modified by Devin Chen on 2025/04/10 16:16
From version 14.1
edited by Mora Zhou
on 2023/11/22 13:54
Change comment: There is no comment for this version
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
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.Mora
1 +XWiki.Hunter
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,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 -== **1.1 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,10 +67,10 @@
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 75  == **1.2 Example key and value** ==
76 76  
... ... @@ -92,16 +92,15 @@
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|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
105 105  
106 106  **2.1.2 Operating procedures**
107 107  
... ... @@ -127,14 +127,6 @@
127 127  
128 128  "sign":"997513ff1320862f0cbb9ce19d0bd253"
129 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"}
... ... @@ -178,7 +178,7 @@
178 178  **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"]]
167 +[[image:X.png||class="img-thumbnail" height="412" width="700"]]
182 182  
183 183  **3.1.2 {{id name="_Toc24963733"/}}Operating procedures**
184 184  
... ... @@ -185,7 +185,7 @@
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"]]
174 +[[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,7 +202,7 @@
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"]]
191 +[[image:V-BOX HTTP manual_html_999832f3a31ac851.png||class="img-thumbnail" height="232" width="700"]]
206 206  
207 207  **3.1.3 Result**
208 208  
... ... @@ -331,7 +331,7 @@
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"]]
320 +[[image:V-BOX HTTP manual_html_5999b14ed63e8065.png||class="img-thumbnail" height="348" width="600"]]
335 335  
336 336  == **3.2 Real-time group list** ==
337 337  
... ... @@ -352,7 +352,7 @@
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"]]
341 +[[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"]]
348 +[[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,7 +372,7 @@
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"]]
361 +[[image:V-BOX HTTP manual_html_cc06cac462c1b77a.png||class="img-thumbnail" height="172" width="800"]]
376 376  
377 377  **3.2.3 Result**
378 378  
... ... @@ -469,7 +469,7 @@
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  
471 471  (% style="text-align:center" %)
472 -[[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"]]
473 473  
474 474  **Step2: **Set parameters on Params
475 475  
... ... @@ -482,7 +482,7 @@
482 482  "pageIndex":"2"
483 483  
484 484  (% style="text-align:center" %)
485 -[[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"]]
486 486  
487 487  **Step3:** Get sign
488 488  
... ... @@ -495,7 +495,7 @@
495 495  {"boxId":"973","groupId":"7325","pageSize":"5","pageIndex":"2","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"0769228e66c945eed5431c41a96949f2"}
496 496  
497 497  (% style="text-align:center" %)
498 -[[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"]]
499 499  
500 500  **3.3.3 Result**
501 501  
... ... @@ -578,7 +578,7 @@
578 578  }
579 579  
580 580  (% style="text-align:center" %)
581 -[[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"]]
582 582  
583 583  == (% id="cke_bm_1151S" style="display:none" %)** {{id name="_Toc24963743"/}}**(%%)**3.4 Tags data list** ==
584 584  
... ... @@ -609,7 +609,7 @@
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  
611 611  (% style="text-align:center" %)
612 -[[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"]]
613 613  
614 614  **Step2: **Set parameters on Params
615 615  
... ... @@ -622,7 +622,7 @@
622 622  "pageIndex":"2"
623 623  
624 624  (% style="text-align:center" %)
625 -[[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"]]
626 626  
627 627  **Step3:** Get sign
628 628  
... ... @@ -695,7 +695,7 @@
695 695  }
696 696  
697 697  (% style="text-align:center" %)
698 -[[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"]]
699 699  
700 700  == **3.5 Modify tag data** ==
701 701  
... ... @@ -716,7 +716,7 @@
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  
718 718  (% style="text-align:center" %)
719 -[[image:1651915094120-525.png||height="45" width="700" class="img-thumbnail"]]
705 +[[image:1651915094120-525.png||class="img-thumbnail" height="45" width="700"]]
720 720  
721 721  **Step2:** Set parameters on Params
722 722  
... ... @@ -725,7 +725,7 @@
725 725  "value":"60"
726 726  
727 727  (% style="text-align:center" %)
728 -[[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"]]
729 729  
730 730  **Step3:** Get sign
731 731  
... ... @@ -738,7 +738,7 @@
738 738  {"monitorId":"91541","value":"60","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"4119b1abc9176a187f781bece04a5296"}
739 739  
740 740  (% style="text-align:center" %)
741 -[[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"]]
742 742  
743 743  **3.5.3 Result**
744 744  
... ... @@ -755,7 +755,7 @@
755 755  }
756 756  
757 757  (% style="text-align:center" %)
758 -[[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"]]
759 759  
760 760  == **3.6 {{id name="_Toc24963751"/}}Historical tags name list** ==
761 761  
... ... @@ -771,12 +771,12 @@
771 771  |monitorId|tag ID
772 772  |monitorName|tag name
773 773  
774 -**3.6.2 Operating procedures**
760 +**​​​​​​​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  
778 778  (% style="text-align:center" %)
779 -[[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"]]
780 780  
781 781  **Step2: **Set parameters on Params
782 782  
... ... @@ -783,7 +783,7 @@
783 783  "boxId":"973"
784 784  
785 785  (% style="text-align:center" %)
786 -[[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"]]
787 787  
788 788  **Step3:** Get sign
789 789  
... ... @@ -796,9 +796,9 @@
796 796  {"boxId":"973","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"9b267b7549083167954b7ede30916ff5"}
797 797  
798 798  (% style="text-align:center" %)
799 -[[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"]]
800 800  
801 -**3.6.3 Result**
787 +**​​​​​​​3.6.3 Result**
802 802  
803 803  {
804 804  
... ... @@ -839,11 +839,11 @@
839 839  }
840 840  
841 841  (% style="text-align:center" %)
842 -[[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"]]
843 843  
844 844  == (% id="cke_bm_1218S" style="display:none" %)** **(%%)**3.7 {{id name="_Toc24963755"/}}Historical tag data list** ==
845 845  
846 -**3.7.1 {{id name="_Toc24963756"/}}Parameters**
832 +**​​​​​​​3.7.1 {{id name="_Toc24963756"/}}Parameters**
847 847  
848 848  (% class="table-bordered" %)
849 849  |**acturl**|(% colspan="3" %)we-data/historydata
... ... @@ -863,12 +863,12 @@
863 863  |totalRecord|(% colspan="2" %)Total records
864 864  |currentPage|(% colspan="2" %)Current page
865 865  
866 -**3.7.2 Operating procedures**
852 +​​​​​​​**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  
870 870  (% style="text-align:center" %)
871 -[[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"]]
872 872  
873 873  **Step2:** Set parameters on Params
874 874  
... ... @@ -883,7 +883,7 @@
883 883  "pageIndex":"2"
884 884  
885 885  (% style="text-align:center" %)
886 -[[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"]]
887 887  
888 888  **Step3: **Get sign
889 889  
... ... @@ -896,7 +896,7 @@
896 896  {"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"}
897 897  
898 898  (% style="text-align:center" %)
899 -[[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"]]
900 900  
901 901  **3.7.3 Result**
902 902  
... ... @@ -959,7 +959,7 @@
959 959  }
960 960  
961 961  (% style="text-align:center" %)
962 -[[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"]]
963 963  
964 964  == **3.8 Alarm tags data list** ==
965 965  
... ... @@ -1003,7 +1003,7 @@
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  
1005 1005  (% style="text-align:center" %)
1006 -[[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"]]
1007 1007  
1008 1008  **Step2:** Set parameters on Params
1009 1009  
... ... @@ -1020,7 +1020,7 @@
1020 1020  "state":"2"
1021 1021  
1022 1022  (% style="text-align:center" %)
1023 -[[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"]]
1024 1024  
1025 1025  **Step3:** Get sign
1026 1026  
... ... @@ -1033,7 +1033,7 @@
1033 1033  {"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"}
1034 1034  
1035 1035  (% style="text-align:center" %)
1036 -[[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"]]
1037 1037  
1038 1038  **3.8.3 Result**
1039 1039  
... ... @@ -1112,7 +1112,7 @@
1112 1112  }
1113 1113  
1114 1114  (% style="text-align:center" %)
1115 -[[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"]]
1116 1116  
1117 1117  == **3.9 Get device state** ==
1118 1118