GET
Users API
L'API Users permet de gérer les utilisateurs de votre application. Vous pouvez créer, récupérer, mettre à jour et supprimer des utilisateurs via ces endpoints.
Base URL : Toutes les requêtes doivent être effectuées à
https://api.example.com/v1
Récupérer un utilisateur
GET
/users/{id}
Récupère les informations détaillées d'un utilisateur spécifique.
Paramètres de chemin
| Paramètre | Type | Description |
|---|---|---|
| id requis | string | L'identifiant unique de l'utilisateur |
curl
curl -X GET "https://api.example.com/v1/users/usr_123456" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json"
200 OK
{
"id": "usr_123456",
"email": "user@example.com",
"name": "John Doe",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-03-20T14:45:00Z",
"status": "active",
"role": "admin"
}
Créer un utilisateur
POST
/users
Crée un nouveau compte utilisateur dans le système.
Paramètres du corps
| Paramètre | Type | Description |
|---|---|---|
| email requis | string | Adresse email de l'utilisateur |
| name requis | string | Nom complet de l'utilisateur |
| password requis | string | Mot de passe (min. 8 caractères) |
| role | string | Rôle de l'utilisateur (default: "user") |
curl
curl -X POST "https://api.example.com/v1/users" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"email": "newuser@example.com",
"name": "Jane Smith",
"password": "securepass123",
"role": "user"
}'
201 Created
{
"id": "usr_789012",
"email": "newuser@example.com",
"name": "Jane Smith",
"created_at": "2024-10-07T15:20:00Z",
"status": "active",
"role": "user"
}
Mettre à jour un utilisateur
PUT
/users/{id}
Met à jour les informations d'un utilisateur existant.
Supprimer un utilisateur
DELETE
/users/{id}
Supprime définitivement un utilisateur du système.
204 No Content
// Aucun contenu retourné en cas de succès
Codes de réponse
200 Succès - La requête a été traitée avec succès
201 Créé - La ressource a été créée avec succès
204 Aucun contenu - Succès sans contenu de réponse
400 Requête invalide - Les paramètres sont incorrects
401 Non autorisé - Authentification requise
404 Non trouvé - La ressource n'existe pas
429 Trop de requêtes - Limite de débit dépassée