Skip to content

Welcome#

Welcome! Once you know how to OAuth with Yale Home, you'll be able to:

  • Get user identification (verified email and phone number, photo posted by user)
  • List the user's locks, doorbells and bridges.
  • Get the last known lock state.
  • Get information about locks, including:
    • battery level
    • other owners and guests
    • existing PIN codes (if there is a keypad)
  • Operate locks with bridges: status check, lock and unlock.
  • Create new PIN codes and retrieve existing PIN codes.
  • Receive webhook notifications of lock operations, and user changes.
  • Retrieve lock operation history, including who operated the lock.

Access to Documentation#

Confidential

This documentation is confidential, and only those who have signed an NDA with Yale Home (or if their company has signed such an NDA) should access these docs. Do not share this documentation with external parties.

That warning is important because you have the ability to give access to these docs. Giving access is as simple as adding the person to your "docs" lock. Each company has one lock registered with Yale Home for access to the documentation. Any user with Owner or Guest access to that lock can also log in to see this documentation. So if you want to add a colleague to access these docs, just add them to your lock.

(All we're doing is checking GET /users/locks/mine after OAuth to see if an approved lock is listed.)

So, the power is yours to regulate who is on your development team.

Note on Development Locks

You can use any Yale Home lock with a bridge for testing APIs. They will all respond to API calls. The only thing special about the "docs" lock is that it grants access to these docs.

Organization of Docs#

You can read this User Guide in order, or you can skip to the sections that interest you most. I'd recommend reading the OAuth section straight through if you haven't done OAuth with Yale Home before.

The API Reference is separate from this User Guide. The API Reference lists individual REST resources and gives example cURL usage for each one.

Questions, Comments and Suggestions#

Please email developer.support@assaabloy.com.