Conventions API
Base URL, authentification JWT, pagination et format des erreurs.
L'API Qovans est une API REST construite avec FastAPI. Elle est accessible sur le port 8000.
Base URL
| Environnement | URL |
|---|---|
| Production | https://apicegid.qovans.com/api/v1 |
| Developpement | http://localhost:8000/api/v1 |
Authentification
L'API utilise des tokens JWT (JSON Web Token). Pour acceder aux endpoints proteges :
- Appelez
POST /api/v1/auth/loginavec email et mot de passe - Recuperez le
access_tokende la reponse - Ajoutez-le a chaque requete dans le header
Authorization:
Authorization: Bearer eyJhbGciOiJIUzI1NiIs...Tokens
| Token | Duree | Usage |
|---|---|---|
| Access token | 15 minutes | Authentifier chaque requete |
| Refresh token | 1 jour | Renouveler l'access token sans re-login |
Quand l'access token expire, appelez POST /api/v1/auth/refresh avec le refresh token pour en obtenir un nouveau.
Pagination
Les listes paginables acceptent les parametres skip (offset) et limit :
GET /api/v1/products?skip=0&limit=20La reponse inclut un champ total pour connaitre le nombre total d'elements.
Format des erreurs
Les erreurs suivent un format standard :
{
"detail": "Description de l'erreur",
"error_code": "NOT_FOUND"
}Codes HTTP courants
| Code | Signification |
|---|---|
| 200 | Succes |
| 201 | Creation reussie |
| 400 | Requete invalide (donnees manquantes ou incorrectes) |
| 401 | Non authentifie (token manquant ou expire) |
| 403 | Interdit (role insuffisant) |
| 404 | Ressource non trouvee |
| 422 | Erreur de validation (champs invalides) |
| 429 | Trop de requetes (rate limiting) |
| 503 | Service Cegid indisponible |
Rate limiting
Les endpoints sensibles (login, register) sont limites en nombre de requetes par IP. En cas de depassement, l'API renvoie un 429 avec un header Retry-After.
Documentation interactive
En mode debug, la documentation Swagger est disponible sur :
/docs— Swagger UI/redoc— ReDoc
En production, ces endpoints sont desactives.