Sifely Open API

Create passcode

test-envirement

POST

/v3/keyboardPwd/add

Passcode Managercreate a passcode to a lock

Request

Authorization

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Query Params

addType

integer <int32>

required

1-Add via APP Bluetooth, default 1 if you don't pass it, you must add it through APP Bluetooth before calling the interface
2 - Add remotely through the gateway or WiFi lock, if it is a WiFi lock or have a connection gateway, you can pass 2 and directly call the interface to add to the lock
3-NB-IoT, if it is an NB-IoT lock, you can pass 3, write through the NB network, and wait for the NB to wake up before issuing the add command.

endDate

integer <int64>

required

valid endDate timestamp with millionSeconds

keyboardPwd

string

required

the passcode like 1234

keyboardPwdName

string

required

passcode alias that you name it

lockId

integer <int64>

required

lockId

startDate

integer <int64>

required

valid startDate timestamp with millionSeconds

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://dev-alexa.sifely.com/v3/keyboardPwd/add?addType&endDate&keyboardPwd&keyboardPwdName&lockId&startDate'

Responses

🟢200OK

*/*

Body

keyboardPwdId

integer <int64>

optional

The generated new passcode id

Example:

24242

Example

{
  "keyboardPwdId": 24242
}

🟢201Created

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

Modified at 2025-01-23 03:56:39

Delete ekey

Change passcode