Difference between revisions of "Dedicated Server Kit REST API"

From gamevanilla wiki
Jump to: navigation, search
m (Protected "Dedicated Server Kit REST API" ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite)))
 
(4 intermediate revisions by the same user not shown)
Line 2: Line 2:
 
|
 
|
  
== <strong>Why?</strong> ==
+
== <strong>register</strong> ==
 +
 
 +
Registers a new user in the system.
 +
 
 +
* <strong>Request type:</strong> POST
 +
 
 +
* <strong>Parameters:</strong>
 +
 
 +
:* email (string): The email of the user.
 +
:* username (string): The username of the user.
 +
:* password (string): The password of the user.
 +
 
 +
== <strong>login</strong> ==
 +
 
 +
Logs an existing user into the system.
 +
 
 +
* <strong>Request type:</strong> POST
 +
 
 +
* <strong>Parameters:</strong>
 +
 
 +
:* username (string): The username of the user.
 +
:* password (string): The password of the user.
 +
 
 +
== <strong>create_game_room</strong> ==
 +
 
 +
Creates a new game room.
 +
 
 +
* <strong>Request type:</strong> POST
 +
 
 +
* <strong>Parameters:</strong>
 +
 
 +
:* max_players (string): The maximum number of players allowed in the room.
 +
== <strong>find_game_rooms</strong> ==
 +
 
 +
Finds all the available game rooms.
 +
 
 +
* <strong>Request type:</strong> POST
 +
 
 +
== <strong>join_game_room</strong> ==
 +
 
 +
Joins an existing game room.
 +
 
 +
* <strong>Request type:</strong> POST
 +
 
 +
* <strong>Parameters:</strong>
 +
 
 +
:* room_id (string): The unique id of the room to join.
  
 
|}
 
|}

Latest revision as of 08:28, 8 July 2020

register

Registers a new user in the system.

  • Request type: POST
  • Parameters:
  • email (string): The email of the user.
  • username (string): The username of the user.
  • password (string): The password of the user.

login

Logs an existing user into the system.

  • Request type: POST
  • Parameters:
  • username (string): The username of the user.
  • password (string): The password of the user.

create_game_room

Creates a new game room.

  • Request type: POST
  • Parameters:
  • max_players (string): The maximum number of players allowed in the room.

find_game_rooms

Finds all the available game rooms.

  • Request type: POST

join_game_room

Joins an existing game room.

  • Request type: POST
  • Parameters:
  • room_id (string): The unique id of the room to join.