- Quick Start
- Getting a User's Keys
- Locking and Unlocking
- Managing Users
- Authenticating with OAuth
- Virtual Locks
Here at Apigy, we believe everything should come with an API. You may have noticed we even put one in our name.
So it gives us great pleasure to present to you the official Lockitron API. With the API, you can now easily write programs to control your locks from homebrew scripts, applications, and websites.
There are two means of authenticating with the Lockitron API. The basic version assigns you access tokens, which you can use in your scripts to lock and unlock your own personal door programmatically. The OAuth version is more complicated but allows you to write robust mashup applications that you can share with other Lockitron owners.
When should I use the basic access tokens, when should I use OAuth?
If you would like to run a cronjob that locks your co-working space every night at 9pm then you should use a basic access token.
If you would like to create an iPhone application that combines a video feed of a door with lock and unlock buttons and release it to the AppStore for anyone to download, then you should use OAuth.
What else should I know?
The API lets you get a list of the locks someone has access too, lock/unlock those locks, invite others, and check to see who has recently used them. While we are still putting the finishing touches on a few parts, you will find the basics all working. If you run into any problems, give us a call at +1 (872) 222 8717 or shoot us an email at email@example.com. Once you get through with authentication, using the API is a cinch. We provide code samples using Ruby and Curl, and an access token autogenerated that will work for you.