Skip to Content

Changes for page 07 HTTP API

Last modified by Devin Chen on 2025/04/10 16:16
From version 8.1
edited by Hunter
on 2023/01/11 18:56
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
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,12 +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 -The timestamp must be unit as Millisecond level
132 -
133 133  **Step4: ** Set common of header
134 134  
135 135  {"comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"997513ff1320862f0cbb9ce19d0bd253"}
... ... @@ -173,7 +173,7 @@
173 173  **3.1.1 {{id name="_Toc24963732"/}}Parameters**
174 174  
175 175  (% style="text-align:center" %)
176 -[[image:X.png||height="412" width="700" class="img-thumbnail"]]
167 +[[image:X.png||class="img-thumbnail" height="412" width="700"]]
177 177  
178 178  **3.1.2 {{id name="_Toc24963733"/}}Operating procedures**
179 179  
... ... @@ -180,7 +180,7 @@
180 180  **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]]
181 181  
182 182  (% style="text-align:center" %)
183 -[[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"]]
184 184  
185 185  **Step2:**  Set parameters on Params
186 186  
... ... @@ -197,7 +197,7 @@
197 197  {"sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"8fb4fbf99fcc1331c3274e708a403034"}
198 198  
199 199  (% style="text-align:center" %)
200 -[[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"]]
201 201  
202 202  **3.1.3 Result**
203 203  
... ... @@ -326,7 +326,7 @@
326 326  }
327 327  
328 328  (% style="text-align:center" %)
329 -[[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"]]
330 330  
331 331  == **3.2 Real-time group list** ==
332 332  
... ... @@ -347,7 +347,7 @@
347 347  **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]]
348 348  
349 349  (% style="text-align:center" %)
350 -[[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"]]
351 351  
352 352  **Step2: **Set parameters on Params
353 353  
... ... @@ -354,7 +354,7 @@
354 354  "boxId": "973"
355 355  
356 356  (% style="text-align:center" %)
357 -[[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"]]
358 358  
359 359  **Step3: **Get sign
360 360  
... ... @@ -367,7 +367,7 @@
367 367  {"boxId":"973","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"9b267b7549083167954b7ede30916ff5"}
368 368  
369 369  (% style="text-align:center" %)
370 -[[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"]]
371 371  
372 372  **3.2.3 Result**
373 373  
... ... @@ -464,7 +464,7 @@
464 464  **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]]
465 465  
466 466  (% style="text-align:center" %)
467 -[[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"]]
468 468  
469 469  **Step2: **Set parameters on Params
470 470  
... ... @@ -477,7 +477,7 @@
477 477  "pageIndex":"2"
478 478  
479 479  (% style="text-align:center" %)
480 -[[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"]]
481 481  
482 482  **Step3:** Get sign
483 483  
... ... @@ -490,7 +490,7 @@
490 490  {"boxId":"973","groupId":"7325","pageSize":"5","pageIndex":"2","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"0769228e66c945eed5431c41a96949f2"}
491 491  
492 492  (% style="text-align:center" %)
493 -[[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"]]
494 494  
495 495  **3.3.3 Result**
496 496  
... ... @@ -573,7 +573,7 @@
573 573  }
574 574  
575 575  (% style="text-align:center" %)
576 -[[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"]]
577 577  
578 578  == (% id="cke_bm_1151S" style="display:none" %)** {{id name="_Toc24963743"/}}**(%%)**3.4 Tags data list** ==
579 579  
... ... @@ -604,7 +604,7 @@
604 604  **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]]
605 605  
606 606  (% style="text-align:center" %)
607 -[[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"]]
608 608  
609 609  **Step2: **Set parameters on Params
610 610  
... ... @@ -617,7 +617,7 @@
617 617  "pageIndex":"2"
618 618  
619 619  (% style="text-align:center" %)
620 -[[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"]]
621 621  
622 622  **Step3:** Get sign
623 623  
... ... @@ -690,7 +690,7 @@
690 690  }
691 691  
692 692  (% style="text-align:center" %)
693 -[[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"]]
694 694  
695 695  == **3.5 Modify tag data** ==
696 696  
... ... @@ -711,7 +711,7 @@
711 711  **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]]
712 712  
713 713  (% style="text-align:center" %)
714 -[[image:1651915094120-525.png||height="45" width="700" class="img-thumbnail"]]
705 +[[image:1651915094120-525.png||class="img-thumbnail" height="45" width="700"]]
715 715  
716 716  **Step2:** Set parameters on Params
717 717  
... ... @@ -720,7 +720,7 @@
720 720  "value":"60"
721 721  
722 722  (% style="text-align:center" %)
723 -[[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"]]
724 724  
725 725  **Step3:** Get sign
726 726  
... ... @@ -733,7 +733,7 @@
733 733  {"monitorId":"91541","value":"60","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"4119b1abc9176a187f781bece04a5296"}
734 734  
735 735  (% style="text-align:center" %)
736 -[[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"]]
737 737  
738 738  **3.5.3 Result**
739 739  
... ... @@ -750,7 +750,7 @@
750 750  }
751 751  
752 752  (% style="text-align:center" %)
753 -[[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"]]
754 754  
755 755  == **3.6 {{id name="_Toc24963751"/}}Historical tags name list** ==
756 756  
... ... @@ -766,12 +766,12 @@
766 766  |monitorId|tag ID
767 767  |monitorName|tag name
768 768  
769 -**3.6.2 Operating procedures**
760 +**​​​​​​​3.6.2 Operating procedures**
770 770  
771 771  **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]]
772 772  
773 773  (% style="text-align:center" %)
774 -[[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"]]
775 775  
776 776  **Step2: **Set parameters on Params
777 777  
... ... @@ -778,7 +778,7 @@
778 778  "boxId":"973"
779 779  
780 780  (% style="text-align:center" %)
781 -[[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"]]
782 782  
783 783  **Step3:** Get sign
784 784  
... ... @@ -791,9 +791,9 @@
791 791  {"boxId":"973","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"9b267b7549083167954b7ede30916ff5"}
792 792  
793 793  (% style="text-align:center" %)
794 -[[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"]]
795 795  
796 -**3.6.3 Result**
787 +**​​​​​​​3.6.3 Result**
797 797  
798 798  {
799 799  
... ... @@ -834,7 +834,7 @@
834 834  }
835 835  
836 836  (% style="text-align:center" %)
837 -[[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"]]
838 838  
839 839  == (% id="cke_bm_1218S" style="display:none" %)** **(%%)**3.7 {{id name="_Toc24963755"/}}Historical tag data list** ==
840 840  
... ... @@ -863,7 +863,7 @@
863 863  **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]]
864 864  
865 865  (% style="text-align:center" %)
866 -[[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"]]
867 867  
868 868  **Step2:** Set parameters on Params
869 869  
... ... @@ -878,7 +878,7 @@
878 878  "pageIndex":"2"
879 879  
880 880  (% style="text-align:center" %)
881 -[[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"]]
882 882  
883 883  **Step3: **Get sign
884 884  
... ... @@ -891,7 +891,7 @@
891 891  {"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"}
892 892  
893 893  (% style="text-align:center" %)
894 -[[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"]]
895 895  
896 896  **3.7.3 Result**
897 897  
... ... @@ -954,7 +954,7 @@
954 954  }
955 955  
956 956  (% style="text-align:center" %)
957 -[[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"]]
958 958  
959 959  == **3.8 Alarm tags data list** ==
960 960  
... ... @@ -998,7 +998,7 @@
998 998  **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]]
999 999  
1000 1000  (% style="text-align:center" %)
1001 -[[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"]]
1002 1002  
1003 1003  **Step2:** Set parameters on Params
1004 1004  
... ... @@ -1015,7 +1015,7 @@
1015 1015  "state":"2"
1016 1016  
1017 1017  (% style="text-align:center" %)
1018 -[[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"]]
1019 1019  
1020 1020  **Step3:** Get sign
1021 1021  
... ... @@ -1028,7 +1028,7 @@
1028 1028  {"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"}
1029 1029  
1030 1030  (% style="text-align:center" %)
1031 -[[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"]]
1032 1032  
1033 1033  **3.8.3 Result**
1034 1034  
... ... @@ -1107,7 +1107,7 @@
1107 1107  }
1108 1108  
1109 1109  (% style="text-align:center" %)
1110 -[[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"]]
1111 1111  
1112 1112  == **3.9 Get device state** ==
1113 1113