getSnapkeyList: Get a list of temporary keys
getSnapkeyList: Get a list of temporary keys
Function details
Obtain the temporary key list of the door lock device.
Request address
https://openapi-[DataCenter].easy4ip.com/openapi/getSnapkeyList
Minimum permissions required for sub-account token request
"Permission":"Config" "Resource":"dev:serial number"
Incoming parameter description
| Parameter name | Parameter type | Required or not | Default value | Legal value | Parameter description |
|---|---|---|---|---|---|
| token | String | Yes | Administrator or sub-account accessToken | ||
| deviceId | String | Yes | Door lock device serial number |
Sample input
{
"system":{
"ver":"1.0",
"appId":"lcdxxxxxxxxx",
"sign":"85384489874412a2e9aa7ac3a8b08309",
"time":1603350639,
"nonce":"350f4c7a-a352-46cf-ae03-f4f526f5d99f"
},
"id":"b8f45dbb-79ad-4a7e-8b24-7eb618c5191f",
"params":{
"token":"At_00000ad9e6e87f0142eb92e207aec46a",
"deviceId":"TESTQWERXXXX"
}
}
Return data field description
| Field name | Field type | Field description | |
|---|---|---|---|
| snapkeys | keyId | String | Secret key unique id |
| snapKey | String | Temporary secret key | |
| name | String | Secret key name | |
| status | String | Temporary key status, notUsed: not used; bUsed: used; failed: expired | |
| createUtcTime | String | The Utc time when the secret key was created, in yyyyMMddTHHmmssZ format | |
| createLocalTime | String | The local time of the secret key creation device, in yyyyMMddTHHmmssZ format | |
| localTime | String | The local time of the device where the temporary key is invalid or used, in the format yyyyMMddTHHmmss | |
| utcTime | String | The UTC time when the temporary key is invalid or used, in the format yyyyMMddTHHmmssZ | |
Sample output
{
"id":"b8f45dbb-79ad-4a7e-8b24-7eb618c5191f",
"result":{
"code":"0",
"msg":"The operation was successful",
"data": {
"snapkeys":[{
"keyId":"100",
"snapKey":"123456",
"name":"Temporary Key 1",
"status":"notUsed",
"createUtcTime":"20170418T162832Z",
"createLocalTime":"20170418T162832Z",
"localTime":"20170418T163832",
"utcTime":"20170418T163832Z"
}]
}
}
}
