Creating Door Lock CRUD Endpoints
Last updated
Last updated
© Seam Labs, Inc. All rights reserved.
Door Lock CRUD endpoints Seam to list door locks owned by a Door Lock Owner and trigger the door lock to open a door.
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
Name | Type | Description |
---|---|---|
Seam may request door lock information to display information about the lock to the connecting user.
GET
https://devicecloud.example.com/locks/<LOCK_ID>
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
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>
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Authorization*
String
Bearer <access_token>
LOCK_ID*
String
Identifier for Lock
Authorization*
String
Bearer <access_token>
Authorization*
String
Bearer <access_token>
Content-Type*
String
application/json