Identification API
Permet de générer, renouveler et supprimer une clé d'accès à l'API.
Générer une clé API
POST/v1/loginAuthentifie l'utilisateur et retourne un token d'accès ainsi qu'un refresh token.
Body (JSON)
| Nom | Type | Requis | Description |
|---|---|---|---|
| username | String | oui | Nom d'utilisateur |
| password | String | oui | Mot de passe |
Réponses
200 — Authentification réussie
json
{
"success": true,
"code": "200",
"message": "OK",
"parameters": {},
"result": {
"token": "string",
"tokenExpirationDate": "datetime",
"refreshToken": "string",
"refreshTokenExpirationDate": "datetime"
}
}400 — Bad Request
json
{
"success": false,
"code": "400",
"message": "Les paramètres username et password sont requis"
}401 — Unauthorized
json
{
"success": false,
"code": "401",
"message": "Identifiants incorrects"
}403 — Forbidden
json
{
"success": false,
"code": "403",
"message": "Utilisateur non autorisé"
}Renouveler une clé API
POST/v1/refreshTokenRenouvelle le token d'accès à partir d'un refresh token valide.
Body (JSON)
| Nom | Type | Requis | Description |
|---|---|---|---|
| refreshToken | String | oui | Refresh token obtenu lors du login |
Réponses
200 — Token renouvelé
json
{
"success": true,
"code": "200",
"message": "OK",
"parameters": {},
"result": {
"token": "string",
"tokenExpirationDate": "datetime",
"refreshToken": "string",
"refreshTokenExpirationDate": "datetime"
}
}400 — Bad Request
json
{
"success": false,
"code": "400",
"message": "Le paramètre refreshToken est requis"
}401 — Unauthorized
json
{
"success": false,
"code": "401",
"message": "Refresh token invalide ou expiré"
}403 — Forbidden
json
{
"success": false,
"code": "403",
"message": "Utilisateur non autorisé"
}Supprimer une clé API
POST/v1/logoutInvalide le token d'accès courant.
Headers
| Nom | Type | Requis | Description |
|---|---|---|---|
| x-access-token | String | oui | Clé API |
Réponses
200 — Déconnexion réussie
json
{
"success": true,
"code": "200",
"message": "OK",
"parameters": {}
}401 — Unauthorized
json
{
"success": false,
"code": "401",
"message": "Clé API invalide"
}