Documentation

API

Description

The API provides a variety of routes that support both the online Blade-based configuration screens as well as the Xamarin-based cross-platform mobile app. The API is used to send data from the configuration screens to the clients and vice versa. In order to achieve client synchronization, data pushing is used as opposed to data polling. Pusher App is used to achieve this goal. The API currently does not support any user authentication platforms using tokens.

Details

• API language: php (Laravel)
• API structure: REST
• Supported HTTP methods: GET, POST, PUT
• Security platforms: CSRF tokens, TLS support
• User authentication platform: none
• User authentication definition: none
• Supported database engine: MySQL
• Database setup-structure: Laravel migrations
• API configuration screens language: Blade HTML

Routes

UserController@get

Changes a game's status to "on-going" (game specified by id).

• Parameters: $id: Game ID
• Associated Route: PUT /game/{id}

UserController@update

Updates the location of a user (user specified by id).

• Parameters: $request: Request (PUT form), $user: User ID
• Associated Route: PUT /api/users/{user}

UserController@store

Creates and stores a new user.

• Parameters: $request: Request (POST form)
• Associated Route: POST /api/users

Method Name	Description	Parameters	Associated Route
ConfigController@startGame	Changes the specified game's status to "on-going".	$id, game ID	PUT /game/{id}
UserController@get	Returns a JSON object of the requested user.	$user, User	GET /api/users/{user}
UserController@update	Updates the specified user's location.	$request, Request $user, User	PUT /api/users/{user}
UserController@store	Creates and stores a user.	$request, Request	POST /api/users

Game