Sifely Open API
  1. Key Manager
Sifely Open API
  • Overview
  • Quick start
  • OAuth Manager
    • Login
      POST
    • Get authorization_code
      POST
    • Get token refresh token
      POST
  • Key Manager
    • Get Ekeys by account
      POST
    • Send ekey
      POST
    • Delete ekey
      POST
  • Passcode Manager
    • Create passcode
      POST
    • Change passcode
      POST
    • Delete passcode
      POST
    • Get passcode
      POST
  • Lock Manager
    • Unlock a lock via gateway
      POST
    • Lock the lock via gateway
      POST
    • Get lock details
      GET
    • Get keys of a lock
      GET
    • Passcode list
      GET
    • Get Lock open state
      GET
  • Group Manager
    • Group list
      GET
  • Card Manager
    • Ic card list
      GET
  • FingerPrint Manager
    • FingerPrint list
      GET
  • Records Manager
    • Get unlock records by lockId
      GET
  1. Key Manager

Send ekey

test-envirement
test-envirement
POST
/v3/key/send
Key ManagerSend a Ekey to an other user or authorizing another person to use your lock

Request

Authorization
Add the parameter
Authorization
to Headers
,whose value is to concatenate the Token after the Bearer.
Example:
Authorization: Bearer ********************
Query Params
lockId
integer <int32>
required
Lock ID
receiverUsername
string 
required
The recipient username
keyName
string 
required
Key name
startDate
integer <int64>
required
Expiration date start time (timestamp, in milliseconds)
endDate
integer <int64>
required
Expiration date end time (timestamp, in milliseconds)
remarks
string 
optional
Notes, comments
remoteEnable
integer <int32>
optional
Whether remote unlocking is supported: 1-yes, 2-no
keyRight
integer <int32>
optional
Whether to authorize the administrator key: 1-Yes, 0-No, do not authorize by default
createUser
integer <int32>
optional
Whether to automatically create a Tech Man account: 1-Yes, 2-No (default 2)

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://dev-alexa.sifely.com/v3/key/send?lockId&receiverUsername&keyName&startDate&endDate'

Responses

🟢200OK
*/*
OK
Body
description
string 
optional
error description
Example:
means yes or not
errcode
integer <int32>
optional
error code
Example:
0
errmsg
string 
optional
error message
Example:
gateway offline
Example
{
  "description": "means yes or not",
  "errcode": 0,
  "errmsg": "gateway offline"
}
🟢201Created
🟠401Unauthorized
🟠403Forbidden
🟠404Record Not Found
Modified at 2025-03-18 09:13:58
Previous
Get Ekeys by account
Next
Delete ekey
Built with