Creating Door Lock CRUD Endpoints

Overview
Door Lock CRUD endpoints Seam to list door locks owned by a Door Lock Owner and trigger the door lock to open a door.
Listing Door Locks
After a Door Lock Owner logs in, Seam lists all the door locks they own and allows them to enable delivery on them. Your API should return a JSON list of door locks.
get
https://devicecloud.example.com
/locks
List all locks owned by Lock Owner
Getting a Lock
Seam may request door lock information to display information about the lock to the connecting user.
get
https://devicecloud.example.com
/locks/<LOCK_ID>
Get information about a single lock
Unlocking a Door Lock
Seam unlocks doors to let in delivery people. If a door is disconnected or you're unable to unlock the door, return HTTP status code 500 with some details (see example below)
post
https://devicecloud.example.com
/locks/<LOCK_ID>/unlock
Temporary unlock the door for a delivery person
Other Door Lock Features
You may want to include additional features for your lock, such as configuring settings that are useful for delivery or apartment management. If you add additional endpoints, you should keep a similar URL format /locks/<LOCK_ID>/<SOME_PROPERTY_OR_FUNCTION>

Creating OAuth Endpoints

Creating Access Code CRUD Endpoints

Last modified 7mo ago