Get one ekey

https://api.sciener.com/v3/key/get

If a user have an ekey of the lock, request this API to get the ekey.

1 Request example


xxxxxxxxxx
curl --location -g --request GET 'https://api.sciener.com/v3/key/get?clientId=fd2ff35ee3d8424c8665c07b7b9a7f45&accessToken=780f7671b6e6be3010d9787f19207aca&lockId=1719&date=1625025703000'

2 Request parameters

Name	Type	Required	Description
clientId	String	Y	client_id from Create application
accessToken	String	Y	Access token，refer to: Get access token
lockId	Int	Y	Lock ID, generated by Lock init
date	Long	Y	Current time (timestamp in millisecond)

3 Response and example

Parameter	Type	Description
keyId	Int	Ekey ID
lockData	String	Lock data, used to operate lock
lockId	Int	Lock ID
userType	String	Ekey type:110301-admin ekey, 110302-common user ekey
keyStatus	String	Refer to: Ekey status
lockName	String	Lock name
lockAlias	String	Lock alias
lockMac	String	Lock MAC
noKeyPwd	String	Super passcode, which only belongs to the admin ekey, can be entered on the keypad to unlock
electricQuantity	Int	Lock battery
startDate	Long	The time when it becomes valid (timestamp in millisecond)
endDate	Long	The time when it is expired (timestamp in millisecond)
remarks	String	Comment
keyRight	Int	Is ekey authorized: 0-NO, 1-yes
featureValue	String	characteristic value. it is used to indicate what kinds of feature do a lock support.
remoteEnable	Int	Is remote unlock enabled: 1-yes,2-no
passageMode	Int	Passage mode：1-enable、2-disable
timezoneRawOffset	Long	The offset between your time zone and UTC, in millisecond
groupId	Int	Group ID
groupName	String	Group name


xxxxxxxxxx
{
    "keyId": 3234293,
    "lockData": "xxxxxxx",
    "lockId": 532323,
    "userType": "110302",
    "keyStatus": "110401",
    "lockName": "M102_ed8e8d",
    "lockAlias": "Front door lock",
    "lockMac": "68:9E:19:00:67:81",
    "noKeyPwd": "345634",
    "electricQuantity": 85,
    "startDate": 1528878944000,
    "endDate": 1628878944000,
    "remarks": "Wish you a happy rent.",
    "keyRight": 1,
    "featureValue": "6C4CD1F3",
    "remoteEnable": 0,
    "passageMode": 1,
    "groupId": 7619,
    "groupName": "The 4th floor"
}