Thanks for using the Heirloom API. We just shipped v1.1, which introduces some minor improvements that may break your code if unaddressed. Thanks for your patience as we work towards more seamless versioning!

Changelog:

QuickLogin/QuickCheckin API

• Challenges endpoint
  • /auth/sessions/challenges is now a GET endpoint (previously a POST) which no longer takes in a request body and requires three headers:
    • X-Heirloom-API-Version : string The API version you’re using (currently only the value 1 is valid)
    • X-Heirloom-API-Key : string The API key for the lock
    • X-Heirloom-Lock-ID : string Either the 6 digit short ID or the longer UUID for a lock
• Streamlined API credential creation
  • Instead of linking API credentials 1-1 to individual locks, API credentials are now severed from specific locks and can be used for any application.
  • You now receive a LockId when you create a new QuickLogin or QuickCheckin lock. This ID can be viewed anytime in the corresponding Lock Details page, or in the upper right hand menu of a QuickCheckin log.
  • You will need to input the relevant LockId to your WebSocketURL and topic.
    • Please see this section of the docs for examples of the places you’ll need to input the LockID