Skip to content

OutlawByteStudios/RESTfulWarbandAPI

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

API calls

Replace API_VERSION with the preferred api version


API_VERSION/ping [GET]

Check basic functionallity
Parameter Description Example Required Type
-

Responses HTTP:200 {"message" => "Pong. API is reachable", "status" => "success"}


API_VERSION/version [GET]

Returns the api version
Parameter Description Example Required Type
-

Responses HTTP:200 {"message" => "API Version x", "status" => "success"}


API_VERSION/handshake [GET]

Shake hands with the server
Parameter Description Example Required Type
-

Responses
HTTP:200 {"message" => "Hello ..., you must be new", "status" => "success"}
HTTP:200 {"message" => "Hello ..., welcome back", "status" => "success"}

API_VERSION/washhands [POST]

Washhands: remove any human identifyable client data like ip etc.
Parameter Description Example Required Type
uid the client uid auth1234abcdef yes Request Body

Responses
HTTP:200 {"message" => "you are not a shadow of your former self", "status" => "success"}