L'API de gestion des utilisateurs vous permet de créer, consulter, mettre à jour et supprimer des utilisateurs. Elle utilise des requêtes HTTP standard (GET, POST, PATCH, DELETE) et travaille avec des données au format JSON.
L’url de base pour cette api est :
<https://127.0.0.1:5000/user>
Récupérer la liste des utilisateurs
Description : Renvoie une liste de tous les utilisateurs
Méthode HTTP : GET
Endpoint : /users
Paramètres : Aucun
Exemple de requête :
curl --location '<http://127.0.0.1:5000/users>'
Exemple de réponse :
Code HTTP : 200 OK
{
"status": 200,
"users": [
{
"created_at": "2025-02-16 19:23:16",
"email": "[email protected]",
"user_id": 3,
"username": "test"
},
{
"created_at": "2025-02-16 19:23:26",
"email": "[email protected]",
"user_id": 4,
"username": "bonjour"
}
]
}
Récupérer les infos d’un utilisateur
Description : Renvoie les infos d’un utilisateur grace a son id, username ou email.
Méthode HTTP : GET
Endpoint : /user?username={username}
ou /user?user_id={id}
ou /user?email={email}
Paramètres :
Nom | Type | Requis | Description |
---|---|---|---|
user_id | id | non | L’id de l’utilisateur |
username | str | non | Pseudo de l’utilisateur |
str | non | Adresse mail de l’utilisateur |
Exemple de requête :
curl --location '<http://127.0.0.1:5000/user?username=charle>'
Exemple de réponse :
Code HTTP : 200 OK
{
"res": {
"created_at": "2025-02-16 19:23:16",
"email": "[email protected]",
"user_id": 3,
"username": "charle"
},
"status": 200
}
Créer un nouvel utilisateur
Description : Renvoie une liste de tous les utilisateurs
Méthode HTTP : GET
Endpoint : /user
Paramètres :
Nom | Type | Requis | Description |
---|---|---|---|
username | str | oui | Pseudo de l’utilisateur |
str | oui | Adresse mail de l’utilisateur | |
password | str | oui | Mot de passe de l’utilisateur |
Exemple de requête :
curl --location '<http://127.0.0.1:5000/user>' \\
--form 'username="bonjour"' \\
--form 'email="[email protected]"' \\
--form 'password="hello"'
Exemple de réponse :
{
"message": "User created successfully.",
"status": 201,
"user_id_created": 5
}
Code HTTP : 201 OK