Changes for page 07 HTTP API

Last modified by Devin Chen on 2025/04/10 16:16

From 8.1 to 9.1 From 20.1 to 21.1

From version 9.1

edited by Hunter
on 2023/03/27 10:15

Change comment: There is no comment for this version

To version 20.1

edited by Devin Chen
on 2025/04/01 11:49

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (3 modified, 0 added, 0 removed)

Details

Page properties

Title

@@ -1,1 +1,1 @@
--7 HTTP API
++07 HTTP API

Author

@@ -1,1 +1,1 @@
--XWiki.Hunter
++XWiki.DevinChen

Content

@@ -1,4 +1,4 @@
--= **1 General** =
++= **General** =
  This documents introduces WECON V-BOX HTTP API. And this document also shows some examples. All example is tested from postman application.
@@ -43,9 +43,12 @@
  screctkey=f1cd9351930d4e589922edbcf3b09a7c
++(% class="box infomessage" %)
++(((
  **✎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)
++)))
--== **1.1 Interface Parameter Description** ==
++== **Interface Parameter Description** ==
  **Global parameters**
@@ -69,7 +69,7 @@
  (% style="text-align:center" %)
  [[image:1.png||height="141" width="500" class="img-thumbnail"]]
--== **1.2 Example key and value** ==
++== **Example key and value** ==
 ).**comid**=2
@@ -80,10 +80,10 @@
 ).**ts**=1573897380
  (((
--= **2 Basic API** =
++= **Basic API** =
  )))
--== **2.1 {{id name="_Toc24963726"/}}Login operation** ==
++== **{{id name="_Toc24963726"/}}Login operation** ==
  (((
  **2.1.1 Parameters**
@@ -100,7 +100,7 @@
  |utype|(% style="width:535px" %)User Type: 1-Manage Account, 2-Viewer Account
  |sid|(% style="width:535px" %)User session ID (Only available for 12 hours)
--**2.1.2 Operating procedures**
++**Operating procedures**
  **Setp1: ** Set http: [[http:~~/~~/api.v-box.net/box-data/api/we-data/login>>url:http://api.v-box.net/box-data/api/we-data/login]]
@@ -124,11 +124,13 @@
  "sign":"997513ff1320862f0cbb9ce19d0bd253"
++{{info}}
  **✎Note: **For Virtual Deployment, the sign string should be append with domain, so the format would be like following:
  alias=xxx&comid=xxx&compvtkey=xxx&domain=xxx&password=xxx&ts=1657682972386&key=f1cd9351930d4e589922edbcf3b09a7c
  The timestamp must be unit as Millisecond level
++{{/info}}
  **Step4: ** Set common of header
@@ -138,7 +138,7 @@
  [[image:V-BOX HTTP manual_html_cbfc9bbb7d0d4f84.png||height="230" width="700" class="img-thumbnail"]]
  (((
--**2.1.3 Result**
++**Result**
  )))
  {
@@ -165,17 +165,17 @@
  [[image:V-BOX HTTP manual_html_b00e7e6a00828e27.png||height="291" width="500" class="img-thumbnail"]]
  (((
--= **3 Service data APIs** =
++= **Service data APIs** =
  )))
--== **3.1 V-Box list** ==
++== **V-Box list** ==
--**3.1.1 {{id name="_Toc24963732"/}}Parameters**
++**{{id name="_Toc24963732"/}}Parameters**
  (% style="text-align:center" %)
  [[image:X.png||height="412" width="700" class="img-thumbnail"]]
--**3.1.2 {{id name="_Toc24963733"/}}Operating procedures**
++**~ {{id name="_Toc24963733"/}}Operating procedures**
  **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]]
@@ -199,7 +199,7 @@
  (% style="text-align:center" %)
  [[image:V-BOX HTTP manual_html_999832f3a31ac851.png||height="232" width="700" class="img-thumbnail"]]
--**3.1.3 Result**
++**Result**
  {
@@ -328,9 +328,9 @@
  (% style="text-align:center" %)
  [[image:V-BOX HTTP manual_html_5999b14ed63e8065.png||height="348" width="600" class="img-thumbnail"]]
--== **3.2 Real-time group list** ==
++== **Real-time group list** ==
--**3.2.1{{id name="_Toc24963736"/}} Parameters**
++**{{id name="_Toc24963736"/}} Parameters**
  (% class="table-bordered" %)
  |**acturl**|(% colspan="3" %)we-data/realgroups
@@ -342,7 +342,7 @@
  |groupId|Group ID
  |groupName|Group name
--**3.2.2 Operating procedures**
++**Operating procedures**
  **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]]
@@ -369,7 +369,7 @@
  (% style="text-align:center" %)
  [[image:V-BOX HTTP manual_html_cc06cac462c1b77a.png||height="172" width="800" class="img-thumbnail"]]
--**3.2.3 Result**
++**Result**
  {
@@ -415,9 +415,9 @@
  [[image:V-BOX HTTP manual_html_2445c358293d621.png||height="531" width="532"]]
--== **3.3 Real-time tags configuration list** ==
++== **Real-time tags configuration list** ==
--**3.3.1 Parameters**
++**Parameters**
  (% class="table-bordered" %)
  |**acturl**|(% colspan="3" %)we-data/realcfgs
@@ -459,7 +459,7 @@
  |totalRecord|(% colspan="2" %)Total record number
  |currentPage|(% colspan="2" %)Current page number
--**3.3.2 Operating procedures**
++**Operating procedures**
  **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]]
@@ -492,7 +492,7 @@
  (% style="text-align:center" %)
  [[image:V-BOX HTTP manual_html_d284dfdd7b4844ee.png||height="288" width="800" class="img-thumbnail"]]
--**3.3.3 Result**
++**Result**
  {
@@ -575,10 +575,14 @@
  (% style="text-align:center" %)
  [[image:V-BOX HTTP manual_html_e7271097b71941cc.png||height="644" width="800" class="img-thumbnail"]]
--== (% id="cke_bm_1151S" style="display:none" %)** {{id name="_Toc24963743"/}}**(%%)**3.4 Tags data list** ==
++== **Tags data list** ==
--**3.4.1 {{id name="_Toc24963744"/}}Parameters**
++{{warning}}
++This API is not for getting the real-time data all the time.If you need to get the continuously updated real-time monitoring point data values,you need to use **[[Send switch to device>>https://docs.we-con.com.cn/bin/view/V-BOX/V-Net/Manual/6%20HTTP%20API/#HSendswitchtodevice]] **API with this API
++{{/warning}}
++**~ {{id name="_Toc24963744"/}}Parameters**
++
  (% class="table-bordered" %)
  |**acturl**|(% colspan="3" %)we-data/realdata
  |**Functions**|(% colspan="3" %)Get the tags data in the specified group in V-BOX.
@@ -599,7 +599,7 @@
  |totalRecord|(% colspan="2" %)Total record
  |currentPage|(% colspan="2" %)current page
--**3.4.2 {{id name="_Toc24963745"/}}Operating procedures**
++**~ {{id name="_Toc24963745"/}}Operating procedures**
  **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]]
@@ -627,7 +627,7 @@
  {"boxId":"973","groupId":"7325","pageSize":"5","pageIndex":"2","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"0769228e66c945eed5431c41a96949f2"}
--**3.4.3 {{id name="_Toc24963746"/}}Result**
++**~ {{id name="_Toc24963746"/}}Result**
  {
@@ -692,10 +692,10 @@
  (% style="text-align:center" %)
  [[image:V-BOX HTTP manual_html_705682e81eae5ea7.png||height="651" width="800" class="img-thumbnail"]]
--== **3.5 Modify tag data** ==
++== **Modify tag data** ==
  (((
--**3.5.1 Parameters**
++**Parameters**
  )))
  (% class="table-bordered" %)
@@ -706,7 +706,7 @@
  |value|value
  |**Return value**|(% colspan="2" %)None
--**3.5.2 Operating procedures**
++**Operating procedures**
  **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]]
@@ -735,7 +735,7 @@
  (% style="text-align:center" %)
  [[image:V-BOX HTTP manual_html_59d54a5d886ef614.png||height="244" width="700" class="img-thumbnail"]]
--**3.5.3 Result**
++**Result**
  {
@@ -752,9 +752,9 @@
  (% style="text-align:center" %)
  [[image:V-BOX HTTP manual_html_590c8dab9e80fd0f.png||height="425" width="700" class="img-thumbnail"]]
--== **3.6 {{id name="_Toc24963751"/}}Historical tags name list** ==
++== **Historical tags name list** ==
--**3.6.1 Parameters**
++**Parameters**
  (% class="table-bordered" %)
  |**acturl**|(% colspan="3" %)we-data/monitors
@@ -766,7 +766,7 @@
  |monitorId|tag ID
  |monitorName|tag name
--**3.6.2 Operating procedures**
++**Operating procedures**
  **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]]
@@ -793,7 +793,7 @@
  (% style="text-align:center" %)
  [[image:V-BOX HTTP manual_html_dba52ac718eeb66e.png||height="228" width="700" class="img-thumbnail"]]
--**3.6.3 Result**
++**Result**
  {
@@ -836,9 +836,9 @@
  (% style="text-align:center" %)
  [[image:V-BOX HTTP manual_html_2a739377a9fb10b2.png||height="400" width="700" class="img-thumbnail"]]
--== (% id="cke_bm_1218S" style="display:none" %)** **(%%)**3.7 {{id name="_Toc24963755"/}}Historical tag data list** ==
++== **Historical tag data list** ==
--**3.7.1 {{id name="_Toc24963756"/}}Parameters**
++**~ {{id name="_Toc24963756"/}}Parameters**
  (% class="table-bordered" %)
  |**acturl**|(% colspan="3" %)we-data/historydata
@@ -858,7 +858,7 @@
  |totalRecord|(% colspan="2" %)Total records
  |currentPage|(% colspan="2" %)Current page
--**3.7.2 Operating procedures**
++**Operating procedures**
  **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]]
@@ -893,7 +893,7 @@
  (% style="text-align:center" %)
  [[image:V-BOX HTTP manual_html_fac48b1179b555ee.png||height="291" width="700" class="img-thumbnail"]]
--**3.7.3 Result**
++**Result**
  {
@@ -956,9 +956,9 @@
  (% style="text-align:center" %)
  [[image:V-BOX HTTP manual_html_f3b62eb69687a214.png||height="476" width="700" class="img-thumbnail"]]
--== **3.8 Alarm tags data list** ==
++== **Alarm tags data list** ==
--**3.8.1 {{id name="_Toc24963760"/}}Parameters**
++**{{id name="_Toc24963760"/}}Parameters**
  (% class="table-bordered" %)
  |**acturl**|(% colspan="3" %)we-data/alarmdata
@@ -993,7 +993,7 @@
  |totalRecord|(% colspan="2" %)Total records
  |currentPage|(% colspan="2" %)Current page
--**3.8.2 {{id name="_Toc24963761"/}}Operating procedures**
++**~ {{id name="_Toc24963761"/}}Operating procedures**
  **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]]
@@ -1030,7 +1030,7 @@
  (% style="text-align:center" %)
  [[image:V-BOX HTTP manual_html_cd9ce84648b86cb9.png||height="269" width="700" class="img-thumbnail"]]
--**3.8.3 Result**
++**Result**
  {
@@ -1109,9 +1109,9 @@
  (% style="text-align:center" %)
  [[image:V-BOX HTTP manual_html_d4a3e0114c402c27.png||height="475" width="700" class="img-thumbnail"]]
--== **3.9 Get device state** ==
++== **Get device state** ==
--**3.9.1 {{id name="_Toc24963760"/}}Parameters**
++**~ {{id name="_Toc24963760"/}}Parameters**
  (% class="table-bordered" %)
  |**acturl**|(% colspan="3" %)we-data/getDeviceState
@@ -1121,7 +1121,7 @@
  |(% rowspan="2" %)**Return value**|Field name|(% colspan="2" %)Description
  |state|(% colspan="2" %)vbox state: 1-online,  0-offline
--== **3.10 Send switch to device** ==
++== **Send switch to device** ==
  **3.10.1 {{id name="_Toc24963760"/}}Parameters**
@@ -1132,9 +1132,9 @@
  |(% style="width:450px" %)boxId|(% colspan="2" %)boxId(required)
  |(% rowspan="1" style="width:102px" %)**Return value**|(% style="width:450px" %)Field name|(% colspan="2" %)Description
--= **4 Appendix** =
++= **Appendix** =
--== (% style="color:inherit; font-family:inherit; font-size:26px" %)**4.1 Data type**(%%) ==
++== (% style="color:inherit; font-family:inherit; font-size:26px" %)**Data type**(%%) ==
 : 16-bit binary

Changes for page 07 HTTP API

Summary

Details

Navigation

Table of Contents