Sifely Open API
    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
      • Random a passcode with offline
        POST
      • Create passcode
        POST
      • Change passcode
        POST
      • Delete passcode
        POST
      • Get passcode
        GET
    • 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
      • Get the owner lock list of an account
        POST
    • Group Manager
      • Group list
        GET
    • Card Manager
      • Get IC card list
        GET
      • Assigns IC card
        POST
      • Delete a IC card from a lock
        POST
    • FingerPrint Manager
      • FingerPrint list
    • Records Manager
      • Get unlock records by lockId
    • Gateway Manager
      • Gateway details
      • Lock's gateways
      • Gateway's locks
    • Schemas
      • Schemas
        • ChallengeDTO
        • KeyListDTO
        • CommandsDTO
        • ListDTO
        • CookieDTO
        • CustomDataDTO
        • Devices
        • DevicesDTO
        • DirectiveDTO
        • PwdListDTO
        • EndpointDTO
        • ExecutionDTO
        • GoogleRequestVO
        • GoogleResponseVO
        • UserInfoDTO
        • Grant
        • Grantee
        • HeaderDTO
        • InputsDTO
        • LoginBody
        • ParamsDTO
        • PayloadDTO
        • RemindConfigVO
        • ResultWrapper«string»
        • RemindersConfigMembersVO
        • Result«List«RemindConfigVO»»
        • Result«string»
        • R«List«UserEntity»»
        • R«UserEntity»
        • R«string»
        • Scope
        • ScopeDTO
        • SmartHomeRequest
        • SysMessageTemplate
        • TableDataInfo
        • UserEntity
        • WixAddOrderVO
      • KeyInfo
      • CardInfo
      • FingerInfo
      • CardAddDTO
      • GroupInfo
      • LockDetailDTO
      • LockVersion
      • GatewayDetailDTO
      • OpenStateDTO
      • OauthDTO
      • PwdAddDTO
      • PwdInfo
      • ListByLockDTO
      • ListData«ListByLockDTO»
      • YesOrNotDTO
      • Page«CardInfo»
      • Page«FingerInfo»
      • ListData«ListLockDTO»
      • ResultWrapper«Map«string,string»»
      • Page«GroupInfo»
      • ListLockDTO
      • Page«KeyInfo»
      • Page«PwdInfo»
      • Page«RecordInfo»
      • RecordInfo
      • ResultWrapper«SysAppClientDetails»
      • ResultWrapper«object»
      • SysAppClientDetails

    Quick start

    Step 1: Get API ClientId & Security#

    You can retrieve the Client ID and Client Secret from the Sifely API Access.

    Step 2: Login or OAuth to get your token#

    Step 2.1 Login to get your token LoginAPI#

    Here is a simple example using cURL calls:

    Step 2.2 OAuth to get your token OAuthAPI#

    Here is a simple example using cURL calls:

    Step 3: Call the sample interface#

    You should add "Bearer" before the header's Authorization value:
    Here is a simple example using cURL calls:

    Work flows#

    image.png

    Error Codes#

    codedescription
    -1003Lock does not exist
    -2025Frozen lock. Can not operate on it now
    -3011Cannot Transfer Lock(s) to Yourself
    -4043The function is not supported for this lock
    -4056Run out of memory
    -4067NB Device is not registered
    -4082Auto locking period invalid
    Modified at 2025-12-04 11:11:09
    Previous
    Overview
    Next
    Login
    Built with