Skip to content

Social Stream t API

atd edited this page Sep 28, 2011 · 11 revisions

1. Description

Social Stream t-API (transmitter API) is the easy to use data api for social stream. Right now the API is just a draft and all methods and policies are open for discussion.

2. Authentication

Currently t-API is being authenticated through Devise's authentication_token.

If you want to try the API, visit

http://myssnode.com/api/keygen

You can also find your api key in your settings page.

3. Signing api requests

Once you know your api key use:

http://myssnode.com/api/method/options?auth_token=yourtokengoeshere

For example:

http://example.com/api/users/options?auth_token=88YeDq13BVzUX4caGt6R

4. Current api methods

4.1 Feeds

api/me/home Return ostatus compliant atom feed for the current user home wall
api/user-slug/home Return ostatus compliant atom feed for the user-slug home wall

4.2 Users

api/me Return the xml for the current user
api/user/user-slug Return the xml for the current user identified by user-slug

4.3 Contacts

Contact's json follow the Activity Stream's schema

api/me/contacts Return the json for the contacts of current user
api/subjects/subject-slug/contacts Return the json for the contacts of subject identified by subject-slug, if the authenticated user has permissions to access them.
api/subjects/subject-slug/contacts?relation=n Return the json for the contacts of subject identified by subject-slug in relation n (a number), if the authenticated user has permissions to access them.
Clone this wiki locally