API Routes

API Routes

Find Players by Name

• Route: GET /find/:query

• Return:

{
   Found: []string	
} // as json

Login

• Route: POST /login

• Request:

{
  "$schema": "http://json-schema.org/schema#",
  "title": "loginRequest",
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "description": "Unique username to login"
    },
    "password": {
      "type": "string",
      "description": "Password"
    }
  }
}

• Return: string

"logged in"

"Password wrong"

"No User with this Username"

Register

• Route: POST /login

• Request:

{
  "$schema": "http://json-schema.org/schema#",
  "title": "registerRequest",
  "type": "object",
  "properties": {
    "displayname": {
      "type": "string",
      "description": "Displayname"
    },
    "username": {
      "type": "string",
      "description": "Unique username to login"
    },
    "password": {
      "type": "string",
      "description": "Password"
    }
  }
}

• Return: string

"Username already taken"

"Registered"

Change Username/Password

• Route: POST /changeData

• Request:

{
  "$schema": "http://json-schema.org/schema#",
  "title": "registerRequest",
  "type": "object",
  "properties": {
    "displayname": {
      "type": "string",
      "description": "Displayname"
    },
    "password": {
      "type": "string",
      "description": "Password"
    }
  }
}

• Return: string

"No sessionkey log in again"

"Data Changes"