Skip to Content

Changes for page 07 HTTP API

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

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -07 HTTP API
1 +7 HTTP API
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.Mora
1 +XWiki.Hunter
Content
... ... @@ -43,10 +43,7 @@
43 43  
44 44  screctkey=f1cd9351930d4e589922edbcf3b09a7c
45 45  
46 -(% class="box infomessage" %)
47 -(((
48 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 -)))
50 50  
51 51  == **1.1 Interface Parameter Description** ==
52 52  
... ... @@ -96,12 +96,12 @@
96 96  |**Acturl**|(% colspan="2" style="width:731px" %)we-data/login
97 97  |**Function**|(% colspan="2" style="width:731px" %)Login with username, email, phone number
98 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
96 +|alias|(% style="width:535px" %)Username, email, phone number
100 100  |password|(% style="width:535px" %)32bit password (MD5 encryption)
101 101  |domain(Optional)|(% style="width:535px" %)3rd party interface domain(Only available for Virtual Deployment)
102 102  |(% rowspan="3" %)**Return value**|Items|(% style="width:535px" %)Description
103 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)
101 +|sid|(% style="width:535px" %)User session ID
105 105  
106 106  **2.1.2 Operating procedures**
107 107  
... ... @@ -127,14 +127,10 @@
127 127  
128 128  "sign":"997513ff1320862f0cbb9ce19d0bd253"
129 129  
130 -{{info}}
131 131  **✎Note: **For Virtual Deployment, the sign string should be append with domain, so the format would be like following:
132 132  
133 133  alias=xxx&comid=xxx&compvtkey=xxx&domain=xxx&password=xxx&ts=1657682972386&key=f1cd9351930d4e589922edbcf3b09a7c
134 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"}
... ... @@ -843,7 +843,7 @@
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**
839 +**​​​​​​​3.7.1 {{id name="_Toc24963756"/}}Parameters**
847 847  
848 848  (% class="table-bordered" %)
849 849  |**acturl**|(% colspan="3" %)we-data/historydata
... ... @@ -863,7 +863,7 @@
863 863  |totalRecord|(% colspan="2" %)Total records
864 864  |currentPage|(% colspan="2" %)Current page
865 865  
866 -**3.7.2 Operating procedures**
859 +​​​​​​​**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  
... ... @@ -963,7 +963,7 @@
963 963  
964 964  == **3.8 Alarm tags data list** ==
965 965  
966 -**​​​​​​​3.8.1 {{id name="_Toc24963760"/}}Parameters**
959 +**​​​​​​​​​​​​​​3.8.1 {{id name="_Toc24963760"/}}Parameters**
967 967  
968 968  (% class="table-bordered" %)
969 969  |**acturl**|(% colspan="3" %)we-data/alarmdata
... ... @@ -1114,9 +1114,9 @@
1114 1114  (% style="text-align:center" %)
1115 1115  [[image:V-BOX HTTP manual_html_d4a3e0114c402c27.png||height="475" width="700" class="img-thumbnail"]]
1116 1116  
1117 -== **Get device state** ==
1110 +== **3.9 Get device state** ==
1118 1118  
1119 -**~ {{id name="_Toc24963760"/}}Parameters**
1112 +**3.9.1 {{id name="_Toc24963760"/}}Parameters**
1120 1120  
1121 1121  (% class="table-bordered" %)
1122 1122  |**acturl**|(% colspan="3" %)we-data/getDeviceState
... ... @@ -1126,7 +1126,7 @@
1126 1126  |(% rowspan="2" %)**Return value**|Field name|(% colspan="2" %)Description
1127 1127  |state|(% colspan="2" %)vbox state: 1-online,  0-offline
1128 1128  
1129 -== **Send switch to device** ==
1122 +== **3.10 Send switch to device** ==
1130 1130  
1131 1131  **3.10.1 {{id name="_Toc24963760"/}}Parameters**
1132 1132  
... ... @@ -1137,9 +1137,9 @@
1137 1137  |(% style="width:450px" %)boxId|(% colspan="2" %)boxId(required)
1138 1138  |(% rowspan="1" style="width:102px" %)**Return value**|(% style="width:450px" %)Field name|(% colspan="2" %)Description
1139 1139  
1140 -= **Appendix** =
1133 += **4 Appendix** =
1141 1141  
1142 -== (% style="color:inherit; font-family:inherit; font-size:26px" %)**Data type**(%%) ==
1135 +== (% style="color:inherit; font-family:inherit; font-size:26px" %)**4.1 Data type**(%%) ==
1143 1143  
1144 1144  100: 16-bit binary
1145 1145