Skip to Content

Changes for page 07 HTTP API

Last modified by Devin Chen on 2025/04/10 16:16
From version 5.1
edited by Hunter
on 2022/07/13 12:04
Change comment: There is no comment for this version
To version 15.1
edited by Mora Zhou
on 2023/12/22 10:03
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -05 HTTP API
1 +07 HTTP API
Parent
... ... @@ -1,1 +1,1 @@
1 -V-BOX.V-Net.1\.User Manual.WebHome
1 +V-BOX.V-Net.Manual.WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.Hunter
1 +XWiki.Mora
Content
... ... @@ -43,7 +43,10 @@
43 43  
44 44  screctkey=f1cd9351930d4e589922edbcf3b09a7c
45 45  
46 +(% class="box infomessage" %)
47 +(((
46 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)
49 +)))
47 47  
48 48  == **1.1 Interface Parameter Description** ==
49 49  
... ... @@ -93,12 +93,12 @@
93 93  |**Acturl**|(% colspan="2" style="width:731px" %)we-data/login
94 94  |**Function**|(% colspan="2" style="width:731px" %)Login with username, email, phone number
95 95  |(% colspan="1" rowspan="4" %)**Parameters**|Items|(% style="width:535px" %)Description
96 -|alias|(% style="width:535px" %)Username, email, phone number
99 +|alias|(% style="width:535px" %)Must be username, registered email will fail to login
97 97  |password|(% style="width:535px" %)32bit password (MD5 encryption)
98 98  |domain(Optional)|(% style="width:535px" %)3rd party interface domain(Only available for Virtual Deployment)
99 99  |(% rowspan="3" %)**Return value**|Items|(% style="width:535px" %)Description
100 100  |utype|(% style="width:535px" %)User Type: 1-Manage Account, 2-Viewer Account
101 -|sid|(% style="width:535px" %)User session ID
104 +|sid|(% style="width:535px" %)User session ID (Only available for 12 hours)
102 102  
103 103  **2.1.2 Operating procedures**
104 104  
... ... @@ -124,10 +124,14 @@
124 124  
125 125  "sign":"997513ff1320862f0cbb9ce19d0bd253"
126 126  
130 +{{info}}
127 127  **✎Note: **For Virtual Deployment, the sign string should be append with domain, so the format would be like following:
128 128  
129 129  alias=xxx&comid=xxx&compvtkey=xxx&domain=xxx&password=xxx&ts=1657682972386&key=f1cd9351930d4e589922edbcf3b09a7c
130 130  
135 +The timestamp must be unit as Millisecond level
136 +{{/info}}
137 +
131 131  **Step4: ** Set common of header
132 132  
133 133  {"comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"997513ff1320862f0cbb9ce19d0bd253"}
... ... @@ -791,7 +791,7 @@
791 791  (% style="text-align:center" %)
792 792  [[image:V-BOX HTTP manual_html_dba52ac718eeb66e.png||height="228" width="700" class="img-thumbnail"]]
793 793  
794 -**​​​​​​​3.6.3 Result**
801 +**3.6.3 Result**
795 795  
796 796  {
797 797  
... ... @@ -836,7 +836,7 @@
836 836  
837 837  == (% id="cke_bm_1218S" style="display:none" %)** **(%%)**3.7 {{id name="_Toc24963755"/}}Historical tag data list** ==
838 838  
839 -**​​​​​​​3.7.1 {{id name="_Toc24963756"/}}Parameters**
846 +**3.7.1 {{id name="_Toc24963756"/}}Parameters**
840 840  
841 841  (% class="table-bordered" %)
842 842  |**acturl**|(% colspan="3" %)we-data/historydata
... ... @@ -856,7 +856,7 @@
856 856  |totalRecord|(% colspan="2" %)Total records
857 857  |currentPage|(% colspan="2" %)Current page
858 858  
859 -​​​​​​​**3.7.2 Operating procedures**
866 +**3.7.2 Operating procedures**
860 860  
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  
... ... @@ -956,7 +956,7 @@
956 956  
957 957  == **3.8 Alarm tags data list** ==
958 958  
959 -**​​​​​​​​​​​​​​3.8.1 {{id name="_Toc24963760"/}}Parameters**
966 +**​​​​​​​3.8.1 {{id name="_Toc24963760"/}}Parameters**
960 960  
961 961  (% class="table-bordered" %)
962 962  |**acturl**|(% colspan="3" %)we-data/alarmdata
... ... @@ -1107,9 +1107,9 @@
1107 1107  (% style="text-align:center" %)
1108 1108  [[image:V-BOX HTTP manual_html_d4a3e0114c402c27.png||height="475" width="700" class="img-thumbnail"]]
1109 1109  
1110 -== **3.9 Get device state** ==
1117 +== **Get device state** ==
1111 1111  
1112 -**3.9.1 {{id name="_Toc24963760"/}}Parameters**
1119 +**~ {{id name="_Toc24963760"/}}Parameters**
1113 1113  
1114 1114  (% class="table-bordered" %)
1115 1115  |**acturl**|(% colspan="3" %)we-data/getDeviceState
... ... @@ -1119,7 +1119,7 @@
1119 1119  |(% rowspan="2" %)**Return value**|Field name|(% colspan="2" %)Description
1120 1120  |state|(% colspan="2" %)vbox state: 1-online,  0-offline
1121 1121  
1122 -== **3.10 Send switch to device** ==
1129 +== **Send switch to device** ==
1123 1123  
1124 1124  **3.10.1 {{id name="_Toc24963760"/}}Parameters**
1125 1125  
... ... @@ -1130,9 +1130,9 @@
1130 1130  |(% style="width:450px" %)boxId|(% colspan="2" %)boxId(required)
1131 1131  |(% rowspan="1" style="width:102px" %)**Return value**|(% style="width:450px" %)Field name|(% colspan="2" %)Description
1132 1132  
1133 -= **4 Appendix** =
1140 += **Appendix** =
1134 1134  
1135 -== (% style="color:inherit; font-family:inherit; font-size:26px" %)**4.1 Data type**(%%) ==
1142 +== (% style="color:inherit; font-family:inherit; font-size:26px" %)**Data type**(%%) ==
1136 1136  
1137 1137  100: 16-bit binary
1138 1138