API

API

Global Success

The following will be returned on every successful call. Additional data will usually be inserted into the result and is listed below each API call.

{
    "success": true
}

Global Error

The following will be returned on every failed call. The HTTP status code should be in the 4xx range. If an error code is in the 5xx range, it is a server error and will most likely be "An unexpected error occurred".

{
    "error": String
}

The error object can be extended by each call to add additional information to the client. All possible error codes are listed below each function with any additional data parameters listed. If no additional data parameters are shown, it only shows a string error message.

/register

Attempt to register a user.

Input

{
    "username": String,
    "password": String
}

Output

{
    "success": true
}

login