Skip to Content

Changes for page 07 HTTP API

Last modified by Devin Chen on 2025/04/10 16:16
From version 6.4
edited by Hunter
on 2022/08/01 10:05
Change comment: Update document after refactoring.
To version 10.1
edited by Hunter
on 2023/03/30 15:43
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -6 HTTP API
1 +7 HTTP API
Content
... ... @@ -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
96 +|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
101 +|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  
127 +{{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  
132 +The timestamp must be unit as Millisecond level
133 +{{/info}}
134 +
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**
798 +**3.6.3 Result**
795 795  
796 796  {
797 797