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 (email) |
| password | String | oui | Mot de passe |
Réponses
200 — Authentification réussie
json
{
"success": true,
"token": "string",
"tokenExpirationDate": "datetime",
"refreshToken": "string",
"refreshTokenExpirationDate": "datetime",
"message": "string"
}Notes :
- Les champs sont retournés à la racine de la réponse (il n'y a pas d'objet
resultni de champcodesur cette route). messageest un texte informatif sur les rappels d'expiration du refresh token (envoyés par email), pas un simple"OK".
400 — Bad Request
json
{
"success": false,
"message": "username et password nécessaire",
"parameters": {}
}401 — Unauthorized
json
{
"success": false,
"message": "Identifiants incorrects"
}403 — Forbidden
json
{
"success": false,
"message": "Accès interdit"
}Retourné si l'utilisateur est inactif, n'a pas de type de compte, ou si l'abonnement n'autorise pas de nouvel utilisateur.
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,
"token": "string",
"tokenExpirationDate": "datetime",
"refreshToken": "string",
"refreshTokenExpirationDate": "datetime"
}Notes :
- Les champs sont retournés à la racine de la réponse (pas d'objet
result, pas de champcode). - Le
refreshTokenrenvoyé est inchangé ; seul letoken(et sa date d'expiration) est régénéré.
400 — Bad Request
json
{
"success": false,
"parameters": { "refreshToken": "string|null" },
"message": "refreshToken nécessaire"
}401 — Unauthorized
json
{
"success": false,
"parameters": { "refreshToken": "string" },
"message": "refreshToken invalide"
}403 — Forbidden
json
{
"success": false,
"parameters": { "refreshToken": "string" },
"message": "Accès interdit"
}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,
"parameters": { "token": "string" },
"message": "token supprimé"
}Note : cette route ne renvoie pas de champ code, et parameters contient le token fourni.
400 — Bad Request
json
{
"success": false,
"parameters": { "token": null },
"message": "token nécessaire"
}401 — Unauthorized
json
{
"success": false,
"parameters": { "token": "string" },
"message": "token invalide"
}