Sifely Open API
  1. API Use Cases
Sifely Open API
  • Overview
  • Quick start
  • API Use Cases
    • Hospitality & Vacation Rental
  • 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
  • Webhooks
    • Setup & Authentication
    • Payload Reference
  • Schemas
    • 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
  1. API Use Cases

Hospitality & Vacation Rental

Sync guest access permissions with your booking calendar#

Our API allows you to synchronize physical access permissions with your booking calendar. Whether you use a Property Management System (PMS) or a custom rental platform, you can automate the lifecycle of a guest’s access—from granting entry at check-in to revoking it at check-out.
If you are looking for a no-code solution, check out our [Direct Integrations with Airbnb and other PMS].

How the Access Management Works#

1. Fully Automated Passcodes (Remote Distribution)#

Passcodes are the most efficient way to achieve a contactless check-in. The entire process, from generation to guest delivery, can be fully automated.
Create Timed Access: Use the Create passcode API to generate a unique code. By setting keyboardPwdType as 3(Timed), and defining the startDate and endDate based on your check-in and check-out times, the code will only be active from the start date and expire at the end date.
Handle Cancellations: Use the Delete passcode API immediately revokes access to maintain property security.
Adjust Bookings: If a guest extends their stay or changes dates, use the Change passcode API to change the passcode validity period.
Offline Workaround: Use the Random a passcode with offline API to ensure guests can always enter, even if the lock’s Wi-Fi connection is down.
Note: Offline passcodes support timed validity but do not support customized digits (they are system-generated for security encryption).

2. Managed Card Access (Manual Handover, Digital Control)#

For properties that prefer physical IC Cards, our API allows you to integrate the card issuance process directly into your own management dashboard. While the physical handover is manual, the access window is digitally controlled.
How the Enrollment Works: This is a two-step process that combines hardware input with API synchronization:
1. Read: Connect a Sifely Card Reader to your windows computer (it acts as an input device). Simply tap a card on the reader to capture its unique Card Number.
2. Assign: Use the Assigns IC card API to send that cardNumber along with the specific startDate and endDate, to the designated lock.
Integrated Workflow: By building this interface into your platform, your staff can program cards and sync them with guest bookings without ever leaving your internal dashboard.
Digital Expiry: Just like passcodes, the card will only be active from the start date and expire at the end date. The lock will automatically reject the card once the stay period concludes.
Instant Revocation: If a card is lost or a guest departs early, use the Delete a IC card from a lock to invalidate the physical credential immediately.
Hardware Requirement: To ensure security and compatibility, this integration requires the use of Sifely dedicated Card Readers and Sifely IC Cards. Third-party cards or readers are not supported.
Modified at 2026-02-10 10:40:07
Previous
Quick start
Next
Login
Built with