MTSGO Client API API documentation version 1.0 alpha 1

/auth

Interface pour l'inscription et l'authentification.

post

Interface pour authentification.

post

Obtenir un jeton d'authentification

Obtenir un jeton d'authentification

Query Parameters

  • application/json: required (object)

    Identifiants de l'utilisateur

    • username: required (string)

      Nom de l'utilisateur

    • passhash: required (string)

      Mot de passe en clair.

HTTP status code 200

Dans le cas ou le couple login/mot de passe est correct.

Body

Media type: application/json

Type: object

Properties
  • user_id: required (integer)

    ID de l'utilisateur en cours.

  • token: required (string)

    Le jeton d'authentification.

HTTP status code 403

Dans le cas ou le couple login/mot de passe est incorrect.

post

Interface pour l'inscription

post

Inscrire un compte

Inscrire un compte

Query Parameters

  • creds: required (object)

    Paramètres du compte qu'on veut créer

    • username: required (string)

      Nom d'utilisateur

    • passwd: required (string)

      Mot de passe en clair.

    • email: required (string)

      E-Mail de l'utilisateur

HTTP status code 200

Dans le cas où le compte a été créé correctement.

HTTP status code 401

Dans le cas où la création du compte a échoué.

Body

Media type: application/text

Type: object

/map

Interface pour obtention de la dernière version de la map.

get

get

Obtenir la dernière version de la map.

/position/

Interface pour mettre à jour à la position du joueur.

post

post

Mettre à jour la position du joueur.

Mettre à jour la position du joueur.

Query Parameters

  • position: required (object)

    Player position

    • x: required (integer)
    • y: required (integer)
    • z: required (integer)

HTTP status code 200

La mise à jour s'est faite correctement.

HTTP status code 401

Une erreur a eu lieu lors de la mise à jour.

Body

Media type: application/json

Type: string

HTTP status code 403

Authentification impossible.

/questions

Interface pour obtenir les questions environnantes et essayer d'y répondre.

get post

get

Obtenir les questions proches du joueur. Attention, Dans des requêtes GET, on parle exclusivement de paramètres GET.

post

Tenter de répondre à une question

Tenter de répondre à une question

Query Parameters

  • user_id: required (integer)

    L'id utilisateur que vous avez obtenu.

  • token: required (string)

    Le jeton d'authentification que vous avez obtenu.

  • answer: required (object)

    Réponse à la question

    • qid: required (integer)

      Identifiant de la question à laquelle on veut répondre.

    • answ_number: required (integer)

      Le numéro de la réponse choisie.

HTTP status code 200

Réponse correcte

HTTP status code 401

Paramètres de requêtes incorrects.

Body

Media type: application/json

Type: string

HTTP status code 402

Mauvaise réponse.

HTTP status code 403

Authentification impossible.

get

get

Obtenir les détails d'une question identifiée par question_id. Attention, Dans des requêtes GET, on parle exclusivement de paramètres GET.

Obtenir les détails d'une question identifiée par question_id. Attention, Dans des requêtes GET, on parle exclusivement de paramètres GET.

URI Parameters

  • question_id: required (string)

Query Parameters

  • user_id: required (integer)

    L'id utilisateur que vous avez obtenu.

  • token: required (string)

    Le jeton d'authentification que vous avez obtenu.

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • id: required (integer)

    Identifiant unique de la question

  • question: required (string)

    Texte de la question

  • rep1: required (string)

    Réponse 1

  • rep2: required (string)

    Réponse 2

  • rep3: required (string)

    Réponse 3

  • rep4: required (string)

    Réponse 4

  • score: required (integer)

    Score attribué si le joueur répond correctement.

  • difficulty: required (integer)

    Difficulté de la question.

  • position: required (array of integer )

    Position de la question

HTTP status code 403

Authentification impossible.

HTTP status code 404

Question non trouvée.

/history/

Obtenir l'historique des dernières questions répondues dans le jeu.

get

get

Obtenir l'historique des dernières questions répondues dans le jeu. (Le nombre de dernières questions est configurable dans le serveur). Attention, Dans des requêtes GET, on parle exclusivement de paramètres GET.

Obtenir l'historique des dernières questions répondues dans le jeu. (Le nombre de dernières questions est configurable dans le serveur). Attention, Dans des requêtes GET, on parle exclusivement de paramètres GET.

Query Parameters

  • user_id: required (integer)

    L'id utilisateur que vous avez obtenu.

  • token: required (string)

    Le jeton d'authentification que vous avez obtenu.

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • history: required (array of HistoryEntry)

    Items: HistoryEntry

    • question: required (string)

      Enoncé de la question.

    • score: required (integer)

      Score apporté par cette question.

    • difficulty: required (integer)

      Difficulté de la question.

    • topic: required (string)

      Domaine de la question.

HTTP status code 403

Authentification impossible.

/player/

Obtenir les informations sur le joueur.

get

get

Obtient les informations sur le joueur. Attention, Dans des requêtes GET, on parle exclusivement de paramètres GET.

Obtient les informations sur le joueur. Attention, Dans des requêtes GET, on parle exclusivement de paramètres GET.

Query Parameters

  • user_id: required (integer)

    L'id utilisateur que vous avez obtenu.

  • token: required (string)

    Le jeton d'authentification que vous avez obtenu.

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • username: required (string)

    Nom de l'utilisateur.

  • score: required (integer)

    Score du joueur.

  • rang: required (integer)

    Rand du joueur _(non implémenté pour le moment, retourne un -1)

HTTP status code 403

Authentification impossible.