REST API
Current Current (RPC) | REST | |
GET /api/status | GET api/sessions | |
POST /api/login | POST api/sessions?token=API_TOKEN | |
GET /api/logout | DELETE api/sessions/SESSIONID or | |
GET /api/get_msgs | GET api/users/USERID/messages | |
GET /api/wait_for_msgs | GET api/users/USERID/messages (long-poll?) | |
GET api/messages/MESSAGEID | ||
POST /api/send_msg | POST api/messages?message=MESSAGE_BODY&via=CLIENT&tags=TAGS&metadata=XML&replyto=MESSAGEID | |
PUT api/messages/MESSAGEID (payload the same as POST) | ||
DELETE api/messages/MESSAGEID | ||
GET /api/get_following | GET api/users/USERID/followees | |
GET /api/get_followers | GET api/users/USERID/followers | |
POST /api/follow | POST api/users/USERID/followees/USERID2 or | |
POST /api/unfollow | DELETE api/users/USERID/followees/USERID2 or | |
GET /api/all_users | GET api/users | |
GET /api/get_tagcloud | GET api/tags | |
GET /api/get_tracking | GET api/users/USERID/tracks | |
POST /api/add_tracking | POST api/users/USERID/tracks?track=TEXT_TO_TRACK | |
POST /api/remove_tracking | DELETE api/users/USERID/tracks/TRACKID | |
GET /api/get_conversation | GET api/conversations/CONVERSATIONID | |
GET /api/get_actions | GET api/users/USERID/actions | |
POST /api/add_action | POST api/users/USERID/actions?name=NAME&test=TEST&action=ACTION | |
POST /api/enable_action | PUT api/users/USERID/actions/ACTIONID?enabled=true|false | |
POST /api/delete_action | DELETE api/users/USERID/actions/ACTIONID | One point to note is that most HTTP clients do not currently support |
...
the "PUT" or "DELETE" methods, so these have to be |
...
simulatedthrough POST methods with an extra parameter. I think that because of the close mapping to resource verbs, is worth using these methods |
...
inthe specification and defining the simulation method for the entire |
...
APIseparately. |