QR Master
1.Overview
Obtain room info.
2.Request method
3.Parameter Description
| Attribute | Type | Constraint | Explanation |
|---|---|---|---|
| accountSid | String | Required | Account ID.(The accountSid and authToken are assigned by QR Master admin when applying for a developer account) |
| timestamp | String | Required | Request timestamp |
| communityNo | String | Required | Community No. |
4.Request address
5.Generate signature for parameter
Ⅰ.Add the authToken parameter to the POST key-value pair to get the original signature data. (The accountSid and authToken are assigned by QR Master admin when applying for a developer account)
Ⅱ.Sort the original signature data in lexicographical order of parameter names.
Ⅲ.Joining together into a string like "key1=value1&key2=value2...". The key/value shall be encoded in x-www-form-urlencode.
Ⅳ.Calculate the sha1 value of the string to get the sig.
Note: this authToken should not be submitted to the network with the POST parameter.
6.Request samples(Raw)
POST http://api.uclbrt.com/Home/Records/fetchRoomInfo?sig=5238550acac60d806e2b051feb19ac3c6657d425 HTTP/1.1
Host: api.uclbrt.com
Connection: Keep-Alive
Accept: application/json
Content-Length: 205
Content-Type: application/x-www-form-urlencoded
accountSid=cd40f2111e0b4b6c283435582aafbd37×tamp=1615864011&communityNo=1316880539
7.Return
Parameter Description
| Attribute | Explanation |
|---|---|
| builderName | Building name |
| builderNum | Building No. |
| floorName | Floor name |
| floorNum | Floor No. |
| no | Room No. |
| num | Lock No. |
| name | Room Type |
| locktype | Lock type |
| boxId | Gateway ID |
| lockindex | Lock number |
| mac | Lock MAC address |
Succeeded：
{"status":200,"info":"success","data":{"builders":[{"builderName":"builder","builderNum":"001","floors":[{"floorNum":"001","floorName":"floor","rooms":[{"no":"1","num":"001","name":"qra","locktype":"QRALOCK"}]}]},{"builderName":"builderTest","builderNum":"002","floors":[{"floorNum":"001","floorName":"floorTest","rooms":[{"no":"1","num":"001","name":"small family","locktype":"QRLOCK","boxId":"754","lockindex":"1","mac":"2FA5E7AEFD3D"}]}]}]}}
Failed：
{"status":5001,"info":"community data exception"}
8.SDK