Release notes

2024-02-19

2023-11-27

2023-10-30

  • improvements in Gate > Unlock Gate endpoint. Endpoint now returns HTTP 408 Request timeout when connecting to BleBox device ends with timeout.

2023-10-16

2023-10-02

  • added new API version 1.32

  • added new user setting on lock device for canceling auto-unlock by other auto-unlock (autoUnlockCancelOtherAutoUnlock)

  • added new user setting in user profile for dynamic changing first lock on device list based on user location (dynamicFirstLock)

  • added new endpoints for lock device calibration

  • removed old endpoints for lock device calibration

2023-09-18

2023-08-07

2023-07-24

  • Bridge extended with LocalApiEnabled setting

  • added rate limiter for Get All Locks endpoint for Personal Access Key (10 requests per 10 minutes allowed)

  • Organization endpoints extended with deviceType property

2023-07-10:

  • added support for location in organization access links

2023-06-26:

2023-06-12:

2023-05-29:

2023-05-15:

  • updated OrganizationAccessLink requirements:
    • name length constrained to 50 chars

    • description length constrained to 500 chars

  • extended Gate models with Icon property, which enables settings predefined icon for Gate device

2023-04-10:

2023-03-27:

  • added a new API version 1.30

  • added organization access links management endpoints

2022-12-05:

  • added a new API version 1.29

  • changed HoldToUnlock user setting type to enum

2022-08-16:

  • added a new API version 1.28

  • removed old organization endpoints

  • unified schema of organization/device area

2022-07-18:

  • added a new API version 1.27

  • removed unlocked notification from global user settings

2022-06-20:

  • added a new API version 1.26

  • added support for device notification settings

  • added paging and filtering to my/lock endpoint

  • added IncludeOrganization parameter to my/lock endpoint

2022-02-28:

  • added new user setting on lock device for WiFi checking in auto-unlock

2022-01-31:

  • added new keypad device setting for enable/disable lock action by keypad button

  • added new events to device activity logs (LockedByKeypadWithPin and LockedByKeypadWithoutPin)

2022-01-17:

  • removed API version 1.9

  • added automatic keypad pairing with bridge when keypad is paired with lock

2021-12-20:

  • added a new API version 1.25

  • added new keypad device setting with battery type

  • added restriction for sound volume values in keypad

2021-11-22:

  • added a new API version 1.24

  • added new keypad device setting for enable/disable bell button

2021-11-08:

  • added a new API version 1.23

  • changed data type of mobile device identifier from int to guid

2021-10-25:

  • added “Other” operating system in POST mobile endpoint

2021-10-11:

  • added timezone validation for devices

  • added endpoints for keypad pin list management

  • added request rate limit in lock sync endpoints

  • added “my” prefix in personal access key endpoints

  • sending e-mail after creating personal access key

2021-09-27:

  • added a new API version 1.22

  • removed “accessType” property from POST/PATCH endpoints for device share

  • max expiration date for personal access key set to 5 years

  • changed default mode in unlock operation to “not pull” and added new “unlock or pull spring” mode, which allows to perform pull when lock is in unlocked state

2021-09-13:

  • added user authentication based on personal access key

  • allowed to set recurring device share only with start/end times or week days

2021-08-30:

  • added a new API version 1.21

  • fixed issue with deleting bridge

2021-08-16:

  • added a new API version 1.20

  • endpoints for lock/unlock/pull operations refactored to have all parameters in path instead of in body

  • added “without auto pull spring” mode in unlock operation endpoint

2021-08-02:

  • endpoints for pairing/unpairing keypad with lock moved to Lock area

  • added information about keypad paired with lock (“connectedToKeypadId” property in Lock type)

2021-06-21:

  • added endpoints to pair/unpair keypad with lock

  • added timezone for keypad device

  • fix: cannot remove device share when device is in organization

2021-06-07:

  • added endpoints to manage keypad devices

2021-05-24:

  • added a new API version 1.19

  • added timezone for lock and bridge devices

  • removed PUT endpoint and added PATCH endpoint to bridge update

2021-05-10:

  • added a new API version 1.18

  • removed “unregister” endpoint from StandardNotificationHub

2021-04-26:

  • added a new API version 1.17

  • added endpoint to check close/open/pull operation status

  • changed response for close/open/pull operation request (added “lastStateChangedDate” and changed result code to 202 Accepted)

  • added “lastStateChangedDate” and “stateChangeResult” to all endpoints returning Lock state

2021-01-18:

  • added a new API version 1.16

  • all user settings moved to a new “userSettings” property in the Lock type

  • removed “bridgeId” property from the Lock type

  • removed “connectedToId”, “iotDeviceName” and “voipNumber” properties from Bridge type

2020-12-07:

  • removed API versions 1.10, 1.11 and 1.12

  • added information about an ongoing bridge software update

  • lock state returned as an enum

2020-11-23:

  • scopes applied to all API endpoints

  • added new endpoints for lock synchronization

  • API versions in swagger sorted in descending order