-
Notifications
You must be signed in to change notification settings - Fork 123
Core API
FellowTraveler edited this page Jul 4, 2011
·
3 revisions
The core of the locker is communicated with in a REST like fashion. By default the listener is localhost only on port 8042.
- / - Retrieve the user interactive dashboard.
- /map - Retrieve a map of the available and installed services.
- /install - Install a new instance of one of the available services.
- /providers - Find services that provide certain types.
- /svcId/at - Schedule a callback to a service URL.
The diary is a collection of messages designed to be user legible to help them better understand the underlying functionality of the Locker. For example when a Connector updates it might send a diary entry of how many items were updated.
- /diary GET - Retrieve the user visible diary for the day.
- /svcId/diary POST - Post to the user visible diary.
Events provide a mechanism for services to use a push API and respond to activities of other services.
- /svcId/listen - Add a listener to an event type with a callback URL.
- /svcId/deafen - Remove an event listener.
- /svcId/event - Post a new event.
A permissioned auth credential key-value store.
- /keychain/put - Put an object on the keychain.
- /keychain/permission - Grant a service permission to an object on the keychain.
- /keychain/meta - Get meta data for keychain objects for a given service type.
- /keychain/get - Get an object (if permission allow).
- /Me/* - Proxy requests to an installed service.