Skip to Content

Wiki source code of 07 HTTP API

Version 18.1 by Mora Zhou on 2023/12/22 10:06
Show last authors
1 = **General** =
2
3 This documents introduces WECON V-BOX HTTP API. And this document also shows some examples. All example is tested from postman application.
4
5 **Transport protocol:** HTTP protocol
6
7 **Server address:**
8
9 China:
10
11 [[http:~~/~~/api.v-box.net>>url:http://api.v-box.net/]]
12
13 Asean:
14
15 [[http:~~/~~/api.asean.v-box.net>>url:http://api.v-box.net/]]
16
17 Europe:
18
19 [[http:~~/~~/api.eu.v-box.net>>url:http://api.v-box.net/]]
20
21 (% style="text-align:center" %)
22 [[image:V-BOX HTTP manual_html_ceb1e13ef4c1fa5d.png||height="361" width="800" class="img-thumbnail"]]
23
24 For **ASEAN server** V-BOX, now can use http, the server address is api.asean.v-box.net.
25
26 The common KEY is:
27
28 **comid=2**
29
30 **comkey=589625dce895454dbff9782c299db156**
31
32 screctkey=f1cd9351930d4e589922edbcf3b09a7c
33
34 {{id name="_GoBack"/}}
35
36 For** EU server **V-BOX, now can use http, the server address is api.eu.v-box.net.
37
38 The common KEY is:
39
40 **comid=100**
41
42 **comkey=8919244ff15d441bae4b944b112a33ea**
43
44 screctkey=f1cd9351930d4e589922edbcf3b09a7c
45
46 (% class="box infomessage" %)
47 (((
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
51 == **Interface Parameter Description** ==
52
53 **Global parameters**
54
55 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)
56
57 (% style="text-align:center" %)
58 [[image:企业微信截图_20210531172144.png||height="467" width="800" class="img-thumbnail"]]
59
60 **The returned result represented by Json and case sensitive:**
61
62 1).Abnormal
63
64 {"code" : 403, "msg" : "SessionID (user session ID) invalid", "reqId": "1502074141465"}
65
66 2).Normal
67
68 {"code" : 200 , "result": {}, "msg" : "ok", "reqId":"1502074141465"}
69
70 **Status Code**
71
72 (% style="text-align:center" %)
73 [[image:1.png||height="141" width="500" class="img-thumbnail"]]
74
75 == **Example key and value** ==
76
77 1).**comid**=2
78
79 2).**comkey**=589625dce895454dbff9782c299db156
80
81 3).**screctkey**=f1cd9351930d4e589922edbcf3b09a7c
82
83 4).**ts**=1573897380
84
85 (((
86 = **Basic API** =
87 )))
88
89 == **{{id name="_Toc24963726"/}}Login operation** ==
90
91 (((
92 **2.1.1 Parameters**
93 )))
94
95 (% class="table-bordered" style="width:888px" %)
96 |**Acturl**|(% colspan="2" style="width:731px" %)we-data/login
97 |**Function**|(% colspan="2" style="width:731px" %)Login with username, email, phone number
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
100 |password|(% style="width:535px" %)32bit password (MD5 encryption)
101 |domain(Optional)|(% style="width:535px" %)3rd party interface domain(Only available for Virtual Deployment)
102 |(% rowspan="3" %)**Return value**|Items|(% style="width:535px" %)Description
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)
105
106 **Operating procedures**
107
108 **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]]
109
110 (% style="text-align:center" %)
111 [[image:V-BOX HTTP manual_html_78fa6b0e5f03b2f2.png||height="63" width="800" class="img-thumbnail"]]
112
113 **Setp2: ** Set parameters on Params
114
115 alias: weconuser
116
117 password: 599a3c736c04e196c58a29f43778f7ea(The md5 encryption result of Wecon159)
118
119 (% style="text-align:center" %)
120 [[image:V-BOX HTTP manual_html_563261d83c8f3530.png||height="250" width="700" class="img-thumbnail"]]
121
122 **Step3:**  Get sign
123
124 alias=weconuser&comid=2&compvtkey=589625dce895454dbff9782c299db156&password=599a3c736c04e196c58a29f43778f7ea&ts=1573897380&key=f1cd9351930d4e589922edbcf3b09a7c
125
126 Put the whole string above encrypted by MD5, so will get the value of "sign"
127
128 "sign":"997513ff1320862f0cbb9ce19d0bd253"
129
130 {{info}}
131 **✎Note: **For Virtual Deployment, the sign string should be append with domain, so the format would be like following:
132
133 alias=xxx&comid=xxx&compvtkey=xxx&domain=xxx&password=xxx&ts=1657682972386&key=f1cd9351930d4e589922edbcf3b09a7c
134
135 The timestamp must be unit as Millisecond level
136 {{/info}}
137
138 **Step4: ** Set common of header
139
140 {"comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"997513ff1320862f0cbb9ce19d0bd253"}
141
142 (% style="text-align:center" %)
143 [[image:V-BOX HTTP manual_html_cbfc9bbb7d0d4f84.png||height="230" width="700" class="img-thumbnail"]]
144
145 (((
146 **Result**
147 )))
148
149 {
150
151 "code": 200,
152
153 "msg": "ok",
154
155 "reqId": "1573899119000",
156
157 "result": {
158
159 "utype": 1,
160
161 "ztRole": 1,
162
163 "sid": "2d7bfd344aa64d8ebc9beea0e4dad8ad"
164
165 }
166
167 }
168
169 (% style="text-align:center" %)
170 [[image:V-BOX HTTP manual_html_b00e7e6a00828e27.png||height="291" width="500" class="img-thumbnail"]]
171
172 (((
173 = **Service data APIs** =
174 )))
175
176 == **V-Box list** ==
177
178 **{{id name="_Toc24963732"/}}Parameters**
179
180 (% style="text-align:center" %)
181 [[image:X.png||height="412" width="700" class="img-thumbnail"]]
182
183 **~ {{id name="_Toc24963733"/}}Operating procedures**
184
185 **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]]
186
187 (% style="text-align:center" %)
188 [[image:V-BOX HTTP manual_html_7555868f6d398292.png||height="48" width="700" class="img-thumbnail"]]
189
190 **Step2:**  Set parameters on Params
191
192 No parameters for this acturl, so no need to set.
193
194 **Step3: ** Get sign
195
196 comid=2&compvtkey=589625dce895454dbff9782c299db156&sid=2d7bfd344aa64d8ebc9beea0e4dad8ad&ts=1573897380&key=f1cd9351930d4e589922edbcf3b09a7c
197
198 MD5 value: 8fb4fbf99fcc1331c3274e708a403034
199
200 **Step4:**  Set common of header
201
202 {"sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"8fb4fbf99fcc1331c3274e708a403034"}
203
204 (% style="text-align:center" %)
205 [[image:V-BOX HTTP manual_html_999832f3a31ac851.png||height="232" width="700" class="img-thumbnail"]]
206
207 **Result**
208
209 {
210
211 "code": 200,
212
213 "msg": "ok",
214
215 "reqId": "1573900361203",
216
217 "result": {
218
219 "list": [
220
221 {
222
223 "groupName": "",
224
225 "boxList": [
226
227 {
228
229 "machineCode": "V01001171116005027a279eb001",
230
231 "devModel": "V-BOX S-00",
232
233 "isAlarm": 0,
234
235 "boxName": "Treatment Systems",
236
237 "remark": "",
238
239 "state": "1",
240
241 "map": "78.178613,9.177124",
242
243 "boxId": "913"
244
245 },
246
247 …………
248
249 {
250
251 "machineCode": "Vir001171116005027a27201908",
252
253 "devModel": "V-BOX S-00",
254
255 "isAlarm": 0,
256
257 "boxName": "(Smart farm)",
258
259 "remark": "",
260
261 "state": "1",
262
263 "map": "88.637476,50.415074",
264
265 "boxId": "973"
266
267 }
268
269 ]
270
271 },
272
273 ……………………
274
275 {
276
277 "groupName": "(Manufacturing)",
278
279 "boxList": [
280
281 {
282
283 "machineCode": "Vir001171116005027a27201904",
284
285 "devModel": "V-BOX S-00",
286
287 "isAlarm": 0,
288
289 "boxName": "(Adjustment)",
290
291 "remark": "",
292
293 "state": "1",
294
295 "map": "109.316038,33.749868",
296
297 "boxId": "957"
298
299 },
300
301 ………………
302
303 {
304
305 "machineCode": "Vir001171116005027a27201915",
306
307 "devModel": "V-BOX S-00",
308
309 "isAlarm": 0,
310
311 "boxName": "",
312
313 "remark": "",
314
315 "state": "1",
316
317 "map": "121.357068,24.312132",
318
319 "boxId": "975"
320
321 }
322
323 ]
324
325 }
326
327 ]
328
329 }
330
331 }
332
333 (% style="text-align:center" %)
334 [[image:V-BOX HTTP manual_html_5999b14ed63e8065.png||height="348" width="600" class="img-thumbnail"]]
335
336 == **Real-time group list** ==
337
338 **{{id name="_Toc24963736"/}} Parameters**
339
340 (% class="table-bordered" %)
341 |**acturl**|(% colspan="3" %)we-data/realgroups
342 |**Functions**|(% colspan="3" %)Get V-BOX’s tags group list
343 |(% rowspan="2" %)**Parameters**|Parameter|(% colspan="2" %)Description
344 |boxId|(% colspan="2" %)VBoxID ("None" means custom grouping)
345 |(% rowspan="4" %)**Return value**|Field name|(% colspan="2" %)Description
346 |(% rowspan="3" %)list|(% colspan="2" %)Group list
347 |groupId|Group ID
348 |groupName|Group name
349
350 **Operating procedures**
351
352 **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]]
353
354 (% style="text-align:center" %)
355 [[image:V-BOX HTTP manual_html_abb2159981171c6.png||height="46" width="700" class="img-thumbnail"]]
356
357 **Step2: **Set parameters on Params
358
359 "boxId": "973"
360
361 (% style="text-align:center" %)
362 [[image:V-BOX HTTP manual_html_5c3ab35ebdab144e.png||height="151" width="800" class="img-thumbnail"]]
363
364 **Step3: **Get sign
365
366 boxId=973&comid=2&compvtkey=589625dce895454dbff9782c299db156&sid=2d7bfd344aa64d8ebc9beea0e4dad8ad&ts=1573897380&key=f1cd9351930d4e589922edbcf3b09a7c
367
368 MD5 value: 9b267b7549083167954b7ede30916ff5
369
370 **Step4: **Set common of header
371
372 {"boxId":"973","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"9b267b7549083167954b7ede30916ff5"}
373
374 (% style="text-align:center" %)
375 [[image:V-BOX HTTP manual_html_cc06cac462c1b77a.png||height="172" width="800" class="img-thumbnail"]]
376
377 **Result**
378
379 {
380
381 "code": 200,
382
383 "msg": "ok",
384
385 "reqId": "1573901906667",
386
387 "result": {
388
389 "list": [
390
391 {
392
393 "groupName": "Temperature",
394
395 "groupId": 7325
396
397 },
398
399 {
400
401 "groupName": "Humidity",
402
403 "groupId": 7326
404
405 },
406
407 {
408
409 "groupName": "Button switch",
410
411 "groupId": 7327
412
413 }
414
415 ]
416
417 }
418
419 }
420
421 [[image:V-BOX HTTP manual_html_2445c358293d621.png||height="531" width="532"]]
422
423 == **Real-time tags configuration list** ==
424
425 **Parameters**
426
427 (% class="table-bordered" %)
428 |**acturl**|(% colspan="3" %)we-data/realcfgs
429 |**Functions**|(% colspan="3" %)Get the tags configuration information in the specified group in V-BOX.
430 |(% rowspan="5" %)**Parameters**|Parameter|(% colspan="2" %)Description
431 |boxId|(% colspan="2" %)VBoxID(“None” means custom tags grouping)
432 |groupId|(% colspan="2" %)Group ID (Required)
433 |pageSize|(% colspan="2" %)Number of each page, 10 by default
434 |pageIndex|(% colspan="2" %)Number of current page, start from 1
435 |(% rowspan="15" %)**Return value**|Field name|(% colspan="2" %)Description
436 |(% rowspan="11" %)cfgList|monitorId|Tags ID
437 |monitorName|Tags name
438 |updTime|Last update time
439 |dataId|(((
440 type of data
441
442 100: 16-bit binary
443
444 101: 16-digit octal
445
446 Refer to Appendix 1
447 )))
448 |addr|Address
449 |addrType|(((
450 0: bit address
451
452 1: byte address
453
454 2: word address
455
456 3: double word
457 )))
458 |digitCount|Integer digits, decimal places
459 |digitBinary|Data type and integer digits, decimal places
460 |dataLimit|Data range
461 |rid|Address
462 |roleType|Permission: 1-read only, 2-write only, 3-read-write
463 |totalPage|(% colspan="2" %)Total pages
464 |totalRecord|(% colspan="2" %)Total record number
465 |currentPage|(% colspan="2" %)Current page number
466
467 **Operating procedures**
468
469 **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]]
470
471 (% style="text-align:center" %)
472 [[image:V-BOX HTTP manual_html_3fff373ae27e2e00.png||height="44" width="700" class="img-thumbnail"]]
473
474 **Step2: **Set parameters on Params
475
476 "boxId":"973"
477
478 "groupId":"7325"
479
480 "pageSize":"5"
481
482 "pageIndex":"2"
483
484 (% style="text-align:center" %)
485 [[image:V-BOX HTTP manual_html_52bf7d95165a3e3a.png||height="273" width="700" class="img-thumbnail"]]
486
487 **Step3:** Get sign
488
489 boxId=973&comid=2&compvtkey=589625dce895454dbff9782c299db156&groupId=7325&pageIndex=2&pageSize=5&sid=2d7bfd344aa64d8ebc9beea0e4dad8ad&ts=1573897380&key=f1cd9351930d4e589922edbcf3b09a7c
490
491 MD5 sign: 0769228e66c945eed5431c41a96949f2
492
493 **Step4:** Set common of header
494
495 {"boxId":"973","groupId":"7325","pageSize":"5","pageIndex":"2","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"0769228e66c945eed5431c41a96949f2"}
496
497 (% style="text-align:center" %)
498 [[image:V-BOX HTTP manual_html_d284dfdd7b4844ee.png||height="288" width="800" class="img-thumbnail"]]
499
500 **Result**
501
502 {
503
504 "code": 200,
505
506 "msg": "ok",
507
508 "reqId": "1573903822419",
509
510 "result": {
511
512 "cfgList": [
513
514 {
515
516 "monitorId": 91545,
517
518 "dataId": 105,
519
520 "monitorName": "Temp_9",
521
522 "updTime": 1571965761000,
523
524 "dataLimit": "0 7999",
525
526 "digitBinary": "十进制",
527
528 "addr": "9",
529
530 "rid": "D",
531
532 "roleType": 3,
533
534 "digitCount": "5,0",
535
536 "addrType": 2
537
538 },
539
540 ……………
541
542 {
543
544 "monitorId": 91541,
545
546 "dataId": 105,
547
548 "monitorName": "Temp_5",
549
550 "updTime": 1571965761000,
551
552 "dataLimit": "0 7999",
553
554 "digitBinary": "十进制",
555
556 "addr": "5",
557
558 "rid": "D",
559
560 "roleType": 3,
561
562 "digitCount": "5,0",
563
564 "addrType": 2
565
566 }
567
568 ],
569
570 "totalPage": 3,
571
572 "totalRecord": 15,
573
574 "currentPage": 2
575
576 }
577
578 }
579
580 (% style="text-align:center" %)
581 [[image:V-BOX HTTP manual_html_e7271097b71941cc.png||height="644" width="800" class="img-thumbnail"]]
582
583 == **Tags data list** ==
584
585 **~ {{id name="_Toc24963744"/}}Parameters**
586
587 (% class="table-bordered" %)
588 |**acturl**|(% colspan="3" %)we-data/realdata
589 |**Functions**|(% colspan="3" %)Get the tags data in the specified group in V-BOX.
590 |(% rowspan="5" %)**Parameters**|Parameter|(% colspan="2" %)Description
591 |boxId|(% colspan="2" %)VBoxID(“None” means custom tag grouping)
592 |groupId|(% colspan="2" %)Group ID (Required)
593 |pageSize|(% colspan="2" %)Number of each page, 10 by default
594 |pageIndex|(% colspan="2" %)Number of current page, start from 1
595 |(% rowspan="11" %)**Return value**|Field name|(% colspan="2" %)Description
596 |(% rowspan="7" %)List|(% colspan="2" %)Real-time data list
597 |com|Communication port ID
598 |monitorId|Tag ID
599 |monitorName|Tag name
600 |state|status
601 |value|Value
602 |groupId|Group ID
603 |totalPage|(% colspan="2" %)Total pages
604 |totalRecord|(% colspan="2" %)Total record
605 |currentPage|(% colspan="2" %)current page
606
607 **~ {{id name="_Toc24963745"/}}Operating procedures**
608
609 **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]]
610
611 (% style="text-align:center" %)
612 [[image:V-BOX HTTP manual_html_839fb0577dac88c1.png||height="45" width="700" class="img-thumbnail"]]
613
614 **Step2: **Set parameters on Params
615
616 "boxId":"973"
617
618 "groupId":"7325"
619
620 "pageSize":"5"
621
622 "pageIndex":"2"
623
624 (% style="text-align:center" %)
625 [[image:V-BOX HTTP manual_html_b860bab44ebbc128.png||height="272" width="700" class="img-thumbnail"]]
626
627 **Step3:** Get sign
628
629 boxId=973&comid=2&compvtkey=589625dce895454dbff9782c299db156&groupId=7325&pageIndex=2&pageSize=5&sid=2d7bfd344aa64d8ebc9beea0e4dad8ad&ts=1573897380&key=f1cd9351930d4e589922edbcf3b09a7c
630
631 MD5 sign: 0769228e66c945eed5431c41a96949f2
632
633 {"boxId":"973","groupId":"7325","pageSize":"5","pageIndex":"2","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"0769228e66c945eed5431c41a96949f2"}
634
635 **~ {{id name="_Toc24963746"/}}Result**
636
637 {
638
639 "code": 200,
640
641 "msg": "ok",
642
643 "reqId": "1573905679365",
644
645 "result": {
646
647 "totalPage": 3,
648
649 "list": [
650
651 {
652
653 "com": 2939,
654
655 "monitorId": 91545,
656
657 "monitorName": "Temp_9",
658
659 "groupId": 0,
660
661 "state": "1",
662
663 "value": "90"
664
665 },
666
667 …………
668
669 },
670
671 {
672
673 "com": 2939,
674
675 "monitorId": 91541,
676
677 "monitorName": "Temp_5",
678
679 "groupId": 0,
680
681 "state": "1",
682
683 "value": "87"
684
685 }
686
687 ],
688
689 "totalRecord": 15,
690
691 "currentPage": 2
692
693 }
694
695 }
696
697 (% style="text-align:center" %)
698 [[image:V-BOX HTTP manual_html_705682e81eae5ea7.png||height="651" width="800" class="img-thumbnail"]]
699
700 == **Modify tag data** ==
701
702 (((
703 **Parameters**
704 )))
705
706 (% class="table-bordered" %)
707 |**acturl**|(% colspan="2" %)we-data/updrealdata
708 |**Functions**|(% colspan="2" %)Modify tag data
709 |(% rowspan="3" %)**Parameters**|Parameter|Description
710 |monitorId|Tag ID
711 |value|value
712 |**Return value**|(% colspan="2" %)None
713
714 **Operating procedures**
715
716 **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]]
717
718 (% style="text-align:center" %)
719 [[image:1651915094120-525.png||height="45" width="700" class="img-thumbnail"]]
720
721 **Step2:** Set parameters on Params
722
723 "monitorId":"91541"
724
725 "value":"60"
726
727 (% style="text-align:center" %)
728 [[image:V-BOX HTTP manual_html_5a3153add75ca7b4.png||height="246" width="800" class="img-thumbnail"]]
729
730 **Step3:** Get sign
731
732 comid=2&compvtkey=589625dce895454dbff9782c299db156&monitorId=91541&sid=2d7bfd344aa64d8ebc9beea0e4dad8ad&ts=1573897380&value=60&key=f1cd9351930d4e589922edbcf3b09a7c
733
734 MD5 sign: 4119b1abc9176a187f781bece04a5296
735
736 **Step4: **Set common of header
737
738 {"monitorId":"91541","value":"60","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"4119b1abc9176a187f781bece04a5296"}
739
740 (% style="text-align:center" %)
741 [[image:V-BOX HTTP manual_html_59d54a5d886ef614.png||height="244" width="700" class="img-thumbnail"]]
742
743 **Result**
744
745 {
746
747 "code": 200,
748
749 "msg": "ok",
750
751 "reqId": "1573907138803",
752
753 "result": {}
754
755 }
756
757 (% style="text-align:center" %)
758 [[image:V-BOX HTTP manual_html_590c8dab9e80fd0f.png||height="425" width="700" class="img-thumbnail"]]
759
760 == **Historical tags name list** ==
761
762 **Parameters**
763
764 (% class="table-bordered" %)
765 |**acturl**|(% colspan="3" %)we-data/monitors
766 |**Functions**|(% colspan="3" %)Get a list of historical tags
767 |(% rowspan="2" %)**Parameters**|Parameter|(% colspan="2" %)Description
768 |boxId|(% colspan="2" %)VBoxID (Not required)
769 |(% rowspan="4" %)**Return value**|Field name|(% colspan="2" %)Description
770 |(% rowspan="3" %)list|(% colspan="2" %)Tag list
771 |monitorId|tag ID
772 |monitorName|tag name
773
774 **Operating procedures**
775
776 **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]]
777
778 (% style="text-align:center" %)
779 [[image:V-BOX HTTP manual_html_456f00c6af3ea1b7.png||height="45" width="700" class="img-thumbnail"]]
780
781 **Step2: **Set parameters on Params
782
783 "boxId":"973"
784
785 (% style="text-align:center" %)
786 [[image:V-BOX HTTP manual_html_8bf7c3f9b3ce3897.png||height="185" width="700" class="img-thumbnail"]]
787
788 **Step3:** Get sign
789
790 boxId=973&comid=2&compvtkey=589625dce895454dbff9782c299db156&sid=2d7bfd344aa64d8ebc9beea0e4dad8ad&ts=1573897380&key=f1cd9351930d4e589922edbcf3b09a7c
791
792 MD5 sign: 9b267b7549083167954b7ede30916ff5
793
794 **Step4:** Set common of header
795
796 {"boxId":"973","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"9b267b7549083167954b7ede30916ff5"}
797
798 (% style="text-align:center" %)
799 [[image:V-BOX HTTP manual_html_dba52ac718eeb66e.png||height="228" width="700" class="img-thumbnail"]]
800
801 **Result**
802
803 {
804
805 "code": 200,
806
807 "msg": "ok",
808
809 "reqId": "1573907813693",
810
811 "result": {
812
813 "list": [
814
815 {
816
817 "monitorId": 91576,
818
819 "monitorName": "Hum",
820
821 "groupId": 7328
822
823 },
824
825 {
826
827 "monitorId": 91577,
828
829 "monitorName": "Temp",
830
831 "groupId": 7328
832
833 }
834
835 ]
836
837 }
838
839 }
840
841 (% style="text-align:center" %)
842 [[image:V-BOX HTTP manual_html_2a739377a9fb10b2.png||height="400" width="700" class="img-thumbnail"]]
843
844 == **Historical tag data list** ==
845
846 **~ {{id name="_Toc24963756"/}}Parameters**
847
848 (% class="table-bordered" %)
849 |**acturl**|(% colspan="3" %)we-data/historydata
850 |**Functions**|(% colspan="3" %)Get historical data
851 |(% rowspan="6" %)**Parameters**|Parameter|(% colspan="2" %)Description
852 |monitorId|(% colspan="2" %)tag ID, (Required)
853 |monitorBeginTime|(% colspan="2" %)Monitoring start time, (Not required)
854 |monitorEndTime|(% colspan="2" %)Monitoring end time, (Not required)
855 |pageSize|(% colspan="2" %)Number of each page, 10 by default
856 |pageIndex|(% colspan="2" %)Number of current page, start from 1
857 |(% rowspan="8" %)**Return value**|Field name|(% colspan="2" %)Description
858 |(% rowspan="4" %)list|(% colspan="2" %)Historical data list
859 |monitorName|tag name
860 |monitorTime|Monitoring time
861 |value|Value
862 |totalPage|(% colspan="2" %)Total pages
863 |totalRecord|(% colspan="2" %)Total records
864 |currentPage|(% colspan="2" %)Current page
865
866 **Operating procedures**
867
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
870 (% style="text-align:center" %)
871 [[image:V-BOX HTTP manual_html_cd2fdea1493dc20e.png||height="47" width="700" class="img-thumbnail"]]
872
873 **Step2:** Set parameters on Params
874
875 "monitorId": 91577
876
877 "monitorBeginTime":"2019-11-16 10:45:44.000"
878
879 "monitorEndTime":"2019-11-16 20:45:44.000"
880
881 "pageSize":"10"
882
883 "pageIndex":"2"
884
885 (% style="text-align:center" %)
886 [[image:V-BOX HTTP manual_html_f169ff87c20ce6c4.png||height="302" width="700" class="img-thumbnail"]]
887
888 **Step3: **Get sign
889
890 comid=2&compvtkey=589625dce895454dbff9782c299db156&monitorBeginTime=2019-11-16 10:45:44.000&monitorEndTime=2019-11-16 20:45:44.000&monitorId=91577&pageIndex=2&pageSize=10&sid=2d7bfd344aa64d8ebc9beea0e4dad8ad&ts=1573897380&key=f1cd9351930d4e589922edbcf3b09a7c
891
892 MD5 sign: feeae8ddb4014951cfc2c02de4744bc4
893
894 **Step4:** Set common of header
895
896 {"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"}
897
898 (% style="text-align:center" %)
899 [[image:V-BOX HTTP manual_html_fac48b1179b555ee.png||height="291" width="700" class="img-thumbnail"]]
900
901 **Result**
902
903 {
904
905 "code": 200,
906
907 "msg": "ok",
908
909 "reqId": "1573909705772",
910
911 "result": {
912
913 "totalPage": 12,
914
915 "list": [
916
917 {
918
919 "monitorTime": 1573905337000,
920
921 "groupName": "His",
922
923 "monitorTime_show": "2019-11-16 19:55:37.000",
924
925 "monitorName": "Temp",
926
927 "groupId": 7328,
928
929 "value": "914"
930
931 },
932
933 ……………
934
935 {
936
937 "monitorTime": 1573902637000,
938
939 "groupName": "His",
940
941 "monitorTime_show": "2019-11-16 19:10:37.000",
942
943 "monitorName": "Temp",
944
945 "groupId": 7328,
946
947 "value": "422"
948
949 }
950
951 ],
952
953 "totalRecord": 120,
954
955 "currentPage": 2
956
957 }
958
959 }
960
961 (% style="text-align:center" %)
962 [[image:V-BOX HTTP manual_html_f3b62eb69687a214.png||height="476" width="700" class="img-thumbnail"]]
963
964 == **Alarm tags data list** ==
965
966 **{{id name="_Toc24963760"/}}Parameters**
967
968 (% class="table-bordered" %)
969 |**acturl**|(% colspan="3" %)we-data/alarmdata
970 |**Function**|(% colspan="3" %)Get alarm data
971 |(% rowspan="9" %)**Parameters**|Parameter|(% colspan="2" %)Description
972 |boxId|(% colspan="2" %)VBoxID, (Required)
973 |monitorBeginTime|(% colspan="2" %)Monitoring start time, (Not required)
974 |monitorEndTime|(% colspan="2" %)Monitoring end time, (Not required)
975 |pageSize|(% colspan="2" %)Number of each page, 10 by default
976 |pageIndex|(% colspan="2" %)Number of current page, start from 1
977 |state|(% colspan="2" %)Status 1-unconfirmed, 2-confirm
978 |alarmType|(% colspan="2" %)Alarm events: 1-trigger alarm, 0-disarm (Not necessary)
979 |alarmLevel|(% colspan="2" %)(((
980 Alarm level: 1 general alarm,
981
982 2 serious alarm,
983
984 3 particularly serious alarm
985
986 (Not necessary)
987 )))
988 |(% rowspan="12" %)**Return value**|Field name|(% colspan="2" %)Description
989 |(% rowspan="8" %)List|(% colspan="2" %)Alarm data list
990 |monitorId|tag ID
991 |monitorName|tag name
992 |state|status
993 |value|Value
994 |monitorTime|Monitoring time
995 |alarmType|Alarm event
996 |alarmLevel|Alarm level
997 |totalPage|(% colspan="2" %)Total pages
998 |totalRecord|(% colspan="2" %)Total records
999 |currentPage|(% colspan="2" %)Current page
1000
1001 **~ {{id name="_Toc24963761"/}}Operating procedures**
1002
1003 **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]]
1004
1005 (% style="text-align:center" %)
1006 [[image:V-BOX HTTP manual_html_4ebee4d4fcf0097c.png||height="45" width="700" class="img-thumbnail"]]
1007
1008 **Step2:** Set parameters on Params
1009
1010 "monitorId":"91931"
1011
1012 "monitorBeginTime":"2019-11-16 20:30:44.000"
1013
1014 "monitorEndTime":"2019-11-16 21:30:44.000"
1015
1016 "pageSize":"10"
1017
1018 "pageIndex":"1"
1019
1020 "state":"2"
1021
1022 (% style="text-align:center" %)
1023 [[image:V-BOX HTTP manual_html_2361d0eaa7447a9c.png||height="327" width="700" class="img-thumbnail"]]
1024
1025 **Step3:** Get sign
1026
1027 comid=2&compvtkey=589625dce895454dbff9782c299db156&monitorBeginTime=2019-11-16 20:30:44.000&monitorEndTime=2019-11-16 21:30:44.000&monitorId=91931&pageIndex=1&pageSize=10&sid=2d7bfd344aa64d8ebc9beea0e4dad8ad&state=2&ts=1573897380&key=f1cd9351930d4e589922edbcf3b09a7c
1028
1029 MD5 sign: 4056006bbc71bd80a3c632987626e15b
1030
1031 **Step4: **Set common of header
1032
1033 {"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"}
1034
1035 (% style="text-align:center" %)
1036 [[image:V-BOX HTTP manual_html_cd9ce84648b86cb9.png||height="269" width="700" class="img-thumbnail"]]
1037
1038 **Result**
1039
1040 {
1041
1042 "code": 200,
1043
1044 "msg": "ok",
1045
1046 "reqId": "1573911745258",
1047
1048 "result": {
1049
1050 "totalPage": 1,
1051
1052 "list": [
1053
1054 {
1055
1056 "monitorTime": 1573910934000,
1057
1058 "alarmType": 0,
1059
1060 "monitorId": 4437,
1061
1062 "monitorTime_show": "2019-11-16 21:28:54",
1063
1064 "monitorName": "Temperature alarm",
1065
1066 "alarmLevel": 2,
1067
1068 "state": 2,
1069
1070 "text": "The temperature is too high",
1071
1072 "value": "1",
1073
1074 "alarm_role": 0
1075
1076 },
1077
1078 …………
1079
1080 {
1081
1082 "monitorTime": 1573910855000,
1083
1084 "alarmType": 1,
1085
1086 "monitorId": 4437,
1087
1088 "monitorTime_show": "2019-11-16 21:27:35",
1089
1090 "monitorName": "Temperature alarm",
1091
1092 "alarmLevel": 2,
1093
1094 "state": 2,
1095
1096 "text": "The temperature is too high",
1097
1098 "value": "18",
1099
1100 "alarm_role": 0
1101
1102 }
1103
1104 ],
1105
1106 "totalRecord": 6,
1107
1108 "currentPage": 1
1109
1110 }
1111
1112 }
1113
1114 (% style="text-align:center" %)
1115 [[image:V-BOX HTTP manual_html_d4a3e0114c402c27.png||height="475" width="700" class="img-thumbnail"]]
1116
1117 == **Get device state** ==
1118
1119 **~ {{id name="_Toc24963760"/}}Parameters**
1120
1121 (% class="table-bordered" %)
1122 |**acturl**|(% colspan="3" %)we-data/getDeviceState
1123 |**Function**|(% colspan="3" %)Get vbox state based on machine code
1124 |(% colspan="1" rowspan="2" %)**Parameters**|Parameter|(% colspan="2" %)Description
1125 |machineCode|(% colspan="2" %)machineCode(required)
1126 |(% rowspan="2" %)**Return value**|Field name|(% colspan="2" %)Description
1127 |state|(% colspan="2" %)vbox state: 1-online,  0-offline
1128
1129 == **Send switch to device** ==
1130
1131 **3.10.1 {{id name="_Toc24963760"/}}Parameters**
1132
1133 (% class="table-bordered" %)
1134 |(% style="width:102px" %)**acturl**|(% colspan="3" style="width:1059px" %)we-data/sendSwitchToDevice
1135 |(% style="width:102px" %)**Function**|(% colspan="3" style="width:1059px" %)Enable vbox reports real-time data, because now the vbox has added a real-time data switch function, only in the real-time data page vbox will report real-time data, otherwise it will not be reported. So if you need to keep to get real-time data, you need to call this interface first, and call it every 20 seconds, so that the vbox will continue to report real-time data.
1136 |(% colspan="1" rowspan="2" style="width:102px" %)**Parameters**|(% style="width:450px" %)Parameter|(% colspan="2" %)Description
1137 |(% style="width:450px" %)boxId|(% colspan="2" %)boxId(required)
1138 |(% rowspan="1" style="width:102px" %)**Return value**|(% style="width:450px" %)Field name|(% colspan="2" %)Description
1139
1140 = **Appendix** =
1141
1142 == (% style="color:inherit; font-family:inherit; font-size:26px" %)**Data type**(%%) ==
1143
1144 100: 16-bit binary
1145
1146 101: 16-bit octal
1147
1148 102: 16-bit hexadecimal
1149
1150 103: 16-bit BCD code
1151
1152 104: 16-bit signed decimal
1153
1154 105: 16-bit unsigned decimal
1155
1156 200: 32-bit binary
1157
1158 201: 32-bit octal
1159
1160 202: 32-bit hexadecimal
1161
1162 203: 32-bit BCD
1163
1164 204: 32-bit signed decimal
1165
1166 205: 32-bit unsigned decimal
1167
1168 206: 32-bit floating
1169
1170 400: 64-bit binary
1171
1172 401: 64-bit octal
1173
1174 402: 64-bit hexadecimal
1175
1176 403: 64-bit BCD
1177
1178 404: 64-bit signed decimal
1179
1180 405: 64-bit unsigned decimal
1181
1182 406: 64-bit floating
1183
1184 1000: string
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194 Version: V1.1.0
1195
1196 Date: Nov 2019