Documentation

Welcome to the stormcaster documentation! This page will explain how to interface your web app with stormcaster. Please note that all URLs are relative to your installation directory.

---

URL	HTTP Verb	Auth Required	Description
api/user/	POST	NO	Create a user
api/user/auth	POST	NO	Authenticate a user
api/user/disconnect	GET	YES	Set user account to logged out
api/user/news	POST	YES	Create a news article
api/user/editnews	POST	YES	Get available news articles (TO BE DEPRECATED)
api/user/news/delete	POST	YES	Delete a news article
api/user/news/edit	POST	YES	Edit a news article
api/user/vote	POST	NO	Vote
api/rankings	GET	NO	Get top 10 characters
api/news/archive	GET	NO	Get available news articles
api/news/{id}	GET	NO	Get specific news article

---

Resource URL: POST /api/user

Response: JSON

Input Validation:

'name' => 'required|unique:accounts|max:127',
'password' => 'required|min:6|max:12',
'verify'   => 'required|same:password',
'email'	   => 'required|email|unique:accounts',

---

Resource URL: POST /api/user/auth

Response: JSON

Input Validation:

'loginfield' => 'required|max:127',
'password'   => 'required',

Notes: loginfield can be either a username or an email address. This method will return a JWT, to be used for future protected methods.

--