4Ply / Bot-chan-rest

Bot-chan rest server

Bot-chan-rest

This is the rest server used to handle requests from http://www.bot-chan.com

Definitions:

• Entity - A user or bot consuming the app that may have hard or soft links to other entities.
• Hard-link - A direct link between two entities, effectively allowing them to interact as one. All resources added to an entity are available to all of it's hard-linked entities, and vice-versa.
• Soft-link - A one-sided link between two entities, used for one entity to subscribe to another entity's public data

Current functionality

(All requests produce application/json)

HTTP Method	URI path	Description	Parameters
POST	/login	Authenticate with the application to recieve a session token (which is valid for 5 minutes)	username, password
POST	/loginCheck	Check if a sessionKey is valid (and has not timed out), and refresh the token's validity timeout (if valid)	sessionKey
POST	/messages	Get Messages (excluding messages marked as deleted) for an ID that match one of the regex patterns	sessionKey,MatcherList<ClientID, Regex>
PUT	/message	Add a message	SessionKey, Message<Message, Sender>
DELETE	/message	Delete a message	SessionKey, ClientID, MessageID