Skip to content

API.Endpoints

Jump to bottom
ClarFleu edited this page Jul 18, 2021 · 10 revisions

Table des matières

Liste des endpoints

Authentification

POST /auth/register

Permet d'enregistrer un nouvel utilisateur.

La représentation json d'un utilisateur doit être envoyée dans le corps de la requête.

Si la requête est un succès, le serveur envoi l'utilisateur ainsi crée en retour.

POST /auth/login

Permet a un utilisateur de se "logger".

La représentation json d'un utilisateur doit être envoyée dans le corps de la requête.

Si la requête est un succès, le serveur envoi le token de l'utilisateur connecté en retour.

POST /auth/logout

Permet à un utilisateur connecté de se "délogger".

La représentation json d'un utilisateur doit être envoyée dans le corps de la requête.

Si la requête est un succès, le serveur envoi un status indiquant le succès de l'action.

POST /auth/verify/user/{userId}

Permet à un nouvel utilisateur de valider son adresse e-mail.

Le token de vérification de l'utilisateur doit être envoyée dans le corps de la requête.

Si la requête est un succès, le serveur envoi un status indiquant le succès de l'action.

Mouvements

GET /movement/user/{idUser}/days/{dayNbr}

Permet de récupérer les mouvements effectué par un utilisateur donné pour une période données.

L'identifiant de l'utilisateur doit remplacer le champ {idUser} dans la requête. Le nombre de jours correspondant à la période désirée doit remplacer le champ {dayNbr} dans la requête. Le token de l'utilisateur doit être entré dans les paramètres de la requête.

Si la requête est un succès, le serveur envoi une liste des mouvements sous format JSON.

POST /movement/user/{idUser}/upload

Permet d'"uploader" un nouveau mouvement pour un utilisateur donné.

L'identifiant de l'utilisateur doit remplacer le champ {idUser} dans la requête. Le token de l'utilisateur doit être entré dans les paramètres de la requête. La représentation json d'un mouvement doit être envoyée dans le corps de la requête.

Si la requête est un succès, le serveur envoi un status indiquant le succès de l'action.

{
    "status": "success",
    "message": "The movement data was uploaded successfully."
}

POST /movement/user/{idUser}/upload/level/{level}

Permet d'"uploader" un nouveau mouvement avec un niveau de douleur associé pour un utilisateur donné.

L'identifiant de l'utilisateur doit remplacer le champ {idUser} dans la requête. Le niveau de douleur de l'utilisateur pour le movement doit remplacer le champ {level} dans la requête. Le token de l'utilisateur doit être entré dans les paramètres de la requête. La représentation json d'un mouvement doit être envoyée dans le corps de la requête.

Si la requête est un succès, le serveur envoi un status indiquant le succès de l'action.

{
    "status": "success",
    "message": "The movement data and activity level was uploaded successfully."
}

Statistiques

GET /stat

Permet de récupérer des statistiques générales (ceci est un endpoint de test). Les statistiques sont récupérées sous forme de text dans un objet JSON.

GET /stat/user/{idUser}/days/{daysNbr}

Permet de récupérer les statistiques d'un utilisateur donné pour une période de {daysNbr} jours donnée.

L'identifiant de l'utilisateur doit remplacer le champ {idUser} dans la requête. Le nombre de jours correspondant à la période désirée doit remplacer le champ {daysNbr} dans la requête. Le token de l'utilisateur doit être entré dans les paramètres de la requête.

Si la requête est un succès, le serveur envoi une représentation JSON des statistiques.

Conseils

GET /tip/user/{idUser}

Permet de récupérer des conseils adaptés pour l'utilisateur donné. Cet endpoint utilise les statistiques sur les 5 derniers jours. Le token de l'utilisateur doit être entré dans les paramètres de la requête.

Si la requête est un succès, le serveur envoi une représentation JSON des conseils.

GET /tip/user/{idUser}/days/{daysNbr}

Permet de récupérer des conseils adaptés pour un utilisateur donné et pour une période de {daysNbr} jours donnée.

L'identifiant de l'utilisateur doit remplacer le champ {idUser} dans la requête. Le nombre de jours correspondant à la période désirée doit remplacer le champ {daysNbr} dans la requête. Le token de l'utilisateur doit être entré dans les paramètres de la requête.

Si la requête est un succès, le serveur envoi une représentation JSON des conseils.

Douleurs

POST /pain/user/{idUser}/upload/

Permet d'"uploader" un nouveau niveau de douleur pour un utilisateur donné.

L'identifiant de l'utilisateur doit remplacer le champ {idUser} dans la requête. Le token de l'utilisateur doit être entré dans les paramètres de la requête. La représentation json d'un niveau de douleur doit être envoyée dans le corps de la requête.

Si la requête est un succès, le serveur envoi un status indiquant le succès de l'action.

{
    "status": "success",
    "message": "The pain data was uploaded successfully."
}

Activité

GET /activity/user/{idUser}/date/{date}

Permet de récupérer l'activité d'un utilisateur pour une date donnée.

L'identifiant de l'utilisateur doit remplacer le champ {idUser} dans la requête. La date voulue doit remplacer le champ {date} dans la requête. Le token de l'utilisateur doit être entré dans les paramètres de la requête.

Si la requête est un succès, le serveur envoi l'activité sous format json. Sinon, une erreur est envoyée.

POST /activity/user/{idUser}/upload

Permet d'"uploader" une nouvelle activité pour un utilisateur donné.

L'identifiant de l'utilisateur doit remplacer le champ {idUser} dans la requête. Le token de l'utilisateur doit être entré dans les paramètres de la requête. La représentation json d'une activité doit être envoyée dans le corps de la requête.

Si la requête est un succès, le serveur envoi un status indiquant le succès de l'action.

{
    "status": "success",
    "message": "The activity data was uploaded successfully."
}

POST /activity/user/{idUser}/upload/exercises

Permet d'"uploader" un nouveau nombre d'exercices effectués par un utilisateur donné.

L'identifiant de l'utilisateur doit remplacer le champ {idUser} dans la requête. Le token de l'utilisateur doit être entré dans les paramètres de la requête. La représentation json d'une activité doit être envoyée dans le corps de la requête.

Si la requête est un succès, le serveur envoi un status indiquant le succès de l'action.

{
    "status": "success",
    "message": "The activity data was uploaded successfully."
}

POST /activity/user/{idUser}/upload/quiz

Permet d'"uploader" un nouveau nombre de quiz effectués par un utilisateur donné.

L'identifiant de l'utilisateur doit remplacer le champ {idUser} dans la requête. Le token de l'utilisateur doit être entré dans les paramètres de la requête. La représentation json d'une activité doit être envoyée dans le corps de la requête.

Si la requête est un succès, le serveur envoi un status indiquant le succès de l'action.

{
    "status": "success",
    "message": "The activity data was uploaded successfully."
}

POST /activity/user/{idUser}/upload/steps

Permet d'"uploader" un nouveau nombre de pas effectués par un utilisateur donné.

L'identifiant de l'utilisateur doit remplacer le champ {idUser} dans la requête. Le token de l'utilisateur doit être entré dans les paramètres de la requête. La représentation json d'une activité doit être envoyée dans le corps de la requête.

Si la requête est un succès, le serveur envoi un status indiquant le succès de l'action.

{
    "status": "success",
    "message": "The activity data was uploaded successfully."
}

Erreurs

Si une erreur apparait, un message expliquant la raison de cette dernière est envoyé. En voici un exemple :

{
  "http-status": 404,
  "error": "The requested resource could not be found."
}

DigiBack - Wiki

Home

API

Endpoints

Objects

Clone this wiki locally