API

The API is available via the path starting from the main script.

./ - The root

The API root gives back basic informations that are remaining constant during a session. The only exception is while changing from online to offline or vice-versa - if the user has been authorized, the API gives more information back.

./auth - Authentification information

The auth API manages the user authentification and gives back information about how the client could perform the authentification. The token received by OAuth2 is also postet to this path.

• GET
• ./auth
• ./auth/{word}
• POST *./auth

./character - Character Management

• GET

• ./character

  Returns a list of characters with informations about that character.

• ./character/current

  Returns informations about the current character

• ./character/create

  Description of a formular to create a character

• ./character/{id}

  Returns information about a character with the specific primary id {id}

• POST

• ./character/create

  Receives informations to create a character (structure is described in GET ./character/create). Answers depends on success or failure of the character creation process.

• PUT

• ./character/current/{id}

  Sets the user's current character to this id. Answer depends on success or failure of this action.