Skip to Content

Changes for page 07 HTTP API

Last modified by Devin Chen on 2025/04/10 16:16
From version 10.1
edited by Hunter
on 2023/03/30 15:43
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 -7 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
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" %)Must be username, registered email will fail to login
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 (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
102 102  
103 103  **2.1.2 Operating procedures**
104 104  
... ... @@ -124,14 +124,6 @@
124 124  
125 125  "sign":"997513ff1320862f0cbb9ce19d0bd253"
126 126  
127 -{{info}}
128 -**✎Note: **For Virtual Deployment, the sign string should be append with domain, so the format would be like following:
129 -
130 -alias=xxx&comid=xxx&compvtkey=xxx&domain=xxx&password=xxx&ts=1657682972386&key=f1cd9351930d4e589922edbcf3b09a7c
131 -
132 -The timestamp must be unit as Millisecond level
133 -{{/info}}
134 -
135 135  **Step4: ** Set common of header
136 136  
137 137  {"comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"997513ff1320862f0cbb9ce19d0bd253"}
... ... @@ -175,7 +175,7 @@
175 175  **3.1.1 {{id name="_Toc24963732"/}}Parameters**
176 176  
177 177  (% style="text-align:center" %)
178 -[[image:X.png||height="412" width="700" class="img-thumbnail"]]
167 +[[image:X.png||class="img-thumbnail" height="412" width="700"]]
179 179  
180 180  **3.1.2 {{id name="_Toc24963733"/}}Operating procedures**
181 181  
... ... @@ -182,7 +182,7 @@
182 182  **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]]
183 183  
184 184  (% style="text-align:center" %)
185 -[[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"]]
186 186  
187 187  **Step2:**  Set parameters on Params
188 188  
... ... @@ -199,7 +199,7 @@
199 199  {"sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"8fb4fbf99fcc1331c3274e708a403034"}
200 200  
201 201  (% style="text-align:center" %)
202 -[[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"]]
203 203  
204 204  **3.1.3 Result**
205 205  
... ... @@ -328,7 +328,7 @@
328 328  }
329 329  
330 330  (% style="text-align:center" %)
331 -[[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"]]
332 332  
333 333  == **3.2 Real-time group list** ==
334 334  
... ... @@ -349,7 +349,7 @@
349 349  **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]]
350 350  
351 351  (% style="text-align:center" %)
352 -[[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"]]
353 353  
354 354  **Step2: **Set parameters on Params
355 355  
... ... @@ -356,7 +356,7 @@
356 356  "boxId": "973"
357 357  
358 358  (% style="text-align:center" %)
359 -[[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"]]
360 360  
361 361  **Step3: **Get sign
362 362  
... ... @@ -369,7 +369,7 @@
369 369  {"boxId":"973","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"9b267b7549083167954b7ede30916ff5"}
370 370  
371 371  (% style="text-align:center" %)
372 -[[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"]]
373 373  
374 374  **3.2.3 Result**
375 375  
... ... @@ -466,7 +466,7 @@
466 466  **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]]
467 467  
468 468  (% style="text-align:center" %)
469 -[[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"]]
470 470  
471 471  **Step2: **Set parameters on Params
472 472  
... ... @@ -479,7 +479,7 @@
479 479  "pageIndex":"2"
480 480  
481 481  (% style="text-align:center" %)
482 -[[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"]]
483 483  
484 484  **Step3:** Get sign
485 485  
... ... @@ -492,7 +492,7 @@
492 492  {"boxId":"973","groupId":"7325","pageSize":"5","pageIndex":"2","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"0769228e66c945eed5431c41a96949f2"}
493 493  
494 494  (% style="text-align:center" %)
495 -[[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"]]
496 496  
497 497  **3.3.3 Result**
498 498  
... ... @@ -575,7 +575,7 @@
575 575  }
576 576  
577 577  (% style="text-align:center" %)
578 -[[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"]]
579 579  
580 580  == (% id="cke_bm_1151S" style="display:none" %)** {{id name="_Toc24963743"/}}**(%%)**3.4 Tags data list** ==
581 581  
... ... @@ -606,7 +606,7 @@
606 606  **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]]
607 607  
608 608  (% style="text-align:center" %)
609 -[[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"]]
610 610  
611 611  **Step2: **Set parameters on Params
612 612  
... ... @@ -619,7 +619,7 @@
619 619  "pageIndex":"2"
620 620  
621 621  (% style="text-align:center" %)
622 -[[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"]]
623 623  
624 624  **Step3:** Get sign
625 625  
... ... @@ -692,7 +692,7 @@
692 692  }
693 693  
694 694  (% style="text-align:center" %)
695 -[[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"]]
696 696  
697 697  == **3.5 Modify tag data** ==
698 698  
... ... @@ -713,7 +713,7 @@
713 713  **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]]
714 714  
715 715  (% style="text-align:center" %)
716 -[[image:1651915094120-525.png||height="45" width="700" class="img-thumbnail"]]
705 +[[image:1651915094120-525.png||class="img-thumbnail" height="45" width="700"]]
717 717  
718 718  **Step2:** Set parameters on Params
719 719  
... ... @@ -722,7 +722,7 @@
722 722  "value":"60"
723 723  
724 724  (% style="text-align:center" %)
725 -[[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"]]
726 726  
727 727  **Step3:** Get sign
728 728  
... ... @@ -735,7 +735,7 @@
735 735  {"monitorId":"91541","value":"60","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"4119b1abc9176a187f781bece04a5296"}
736 736  
737 737  (% style="text-align:center" %)
738 -[[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"]]
739 739  
740 740  **3.5.3 Result**
741 741  
... ... @@ -752,7 +752,7 @@
752 752  }
753 753  
754 754  (% style="text-align:center" %)
755 -[[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"]]
756 756  
757 757  == **3.6 {{id name="_Toc24963751"/}}Historical tags name list** ==
758 758  
... ... @@ -768,12 +768,12 @@
768 768  |monitorId|tag ID
769 769  |monitorName|tag name
770 770  
771 -**3.6.2 Operating procedures**
760 +**​​​​​​​3.6.2 Operating procedures**
772 772  
773 773  **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]]
774 774  
775 775  (% style="text-align:center" %)
776 -[[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"]]
777 777  
778 778  **Step2: **Set parameters on Params
779 779  
... ... @@ -780,7 +780,7 @@
780 780  "boxId":"973"
781 781  
782 782  (% style="text-align:center" %)
783 -[[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"]]
784 784  
785 785  **Step3:** Get sign
786 786  
... ... @@ -793,9 +793,9 @@
793 793  {"boxId":"973","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"9b267b7549083167954b7ede30916ff5"}
794 794  
795 795  (% style="text-align:center" %)
796 -[[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"]]
797 797  
798 -**3.6.3 Result**
787 +**​​​​​​​3.6.3 Result**
799 799  
800 800  {
801 801  
... ... @@ -836,7 +836,7 @@
836 836  }
837 837  
838 838  (% style="text-align:center" %)
839 -[[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"]]
840 840  
841 841  == (% id="cke_bm_1218S" style="display:none" %)** **(%%)**3.7 {{id name="_Toc24963755"/}}Historical tag data list** ==
842 842  
... ... @@ -865,7 +865,7 @@
865 865  **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]]
866 866  
867 867  (% style="text-align:center" %)
868 -[[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"]]
869 869  
870 870  **Step2:** Set parameters on Params
871 871  
... ... @@ -880,7 +880,7 @@
880 880  "pageIndex":"2"
881 881  
882 882  (% style="text-align:center" %)
883 -[[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"]]
884 884  
885 885  **Step3: **Get sign
886 886  
... ... @@ -893,7 +893,7 @@
893 893  {"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"}
894 894  
895 895  (% style="text-align:center" %)
896 -[[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"]]
897 897  
898 898  **3.7.3 Result**
899 899  
... ... @@ -956,7 +956,7 @@
956 956  }
957 957  
958 958  (% style="text-align:center" %)
959 -[[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"]]
960 960  
961 961  == **3.8 Alarm tags data list** ==
962 962  
... ... @@ -1000,7 +1000,7 @@
1000 1000  **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]]
1001 1001  
1002 1002  (% style="text-align:center" %)
1003 -[[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"]]
1004 1004  
1005 1005  **Step2:** Set parameters on Params
1006 1006  
... ... @@ -1017,7 +1017,7 @@
1017 1017  "state":"2"
1018 1018  
1019 1019  (% style="text-align:center" %)
1020 -[[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"]]
1021 1021  
1022 1022  **Step3:** Get sign
1023 1023  
... ... @@ -1030,7 +1030,7 @@
1030 1030  {"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"}
1031 1031  
1032 1032  (% style="text-align:center" %)
1033 -[[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"]]
1034 1034  
1035 1035  **3.8.3 Result**
1036 1036  
... ... @@ -1109,7 +1109,7 @@
1109 1109  }
1110 1110  
1111 1111  (% style="text-align:center" %)
1112 -[[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"]]
1113 1113  
1114 1114  == **3.9 Get device state** ==
1115 1115