Creating a Seam-Compatible Door Locks API
Seam integrates with Intercom systems to enable them to receive deliveries from major delivery providers. After making your intercom API seam-compatible, you don’t need to do any additional effort to be compatible with major US delivery providers, a major selling point for US intercom systems.
To make your system compatible, you should create a HTTP REST API with OAuth for authentication and CRUD-style endpoints for listing intercoms, unlocking doors, and managing access codes. This guide will walk you through creating that API, and have examples for requests/responses. If you need any support, contact
Seam can integrate with systems that use Authentication systems other than OAuth, to inquire about alternateAuthentication mechanism, briefly describe your system in an email to
No access codes on your intercom system? That's OK, as long as the system can be remotely unlocked most delivery providers are still compatible, just skip the access code CRUD endpoints.
There are three links below, each link will walk you through the endpoints you'll need to create for Seam to interact with your system.
You'll need to host these endpoints on a publicly accessible server. We recommend something like
devicecloud.companyname.com. If you already have a server and a domain, you can use a base path on your existing server, e.g.
companyname.com/somebasepath/.... Seam will prepend the base path to all of our requests.
- 5.Example Project in Python (coming soon)