Endpoints
Liste des routes de l'API du Core.
TODO : méthodes HTTP, codes de réponse et corps de requête à confirmer avec le backend avant publication.
Base : /api/v1
Santé
| Route | Description |
|---|---|
GET /health | État du service. Sans authentification. |
Authentification
| Route | Description |
|---|---|
POST /auth/login | Ouvre une session. |
POST /auth/logout | Ferme la session. |
GET /auth/session | Retourne la session courante. |
GET /auth/me | Retourne l'utilisateur connecté. |
Utilisateurs
| Route | Description |
|---|---|
/users | Gestion des utilisateurs. |
Foyers et membres
| Route | Description |
|---|---|
/families | Gestion des foyers. |
/families/:familyId/members | Membres d'un foyer, avec rôle et tranche d'âge. |
Contrôle d'accès
Exemple
curl https://unifam.example.com/api/v1/healthErreurs
Toutes les erreurs de l'API suivent le même contrat, défini dans le SDK (ApiErrorSchema).
| Champ | Type | Description |
|---|---|---|
statusCode | nombre | Code HTTP de la réponse. |
code | texte | Identifiant stable de l'erreur, destiné aux programmes. |
message | texte | Description lisible de l'erreur. |
details | facultatif | Informations complémentaires (par exemple les champs invalides). |
Exemple (valeurs données à titre d'illustration) :
{
"statusCode": 403,
"code": "FORBIDDEN",
"message": "Vous n'avez pas le droit d'effectuer cette action."
}Le contrat est défini d'abord dans le SDK, puis implémenté dans le backend. TODO : liste des valeurs de code et structure exacte de details, à publier avec l'implémentation.