Authentification de l’API

Description

Ce point d’accès permet d’authentifier un utilisateur en vérifiant son adresse email et son mot de passe. En cas de succès, un token d’accès (JWT) est généré et retourné, permettant ainsi l’accès sécurisé aux autres endpoints de l’API.

Endpoint

URL: /account/auth
Méthode: POST
Content-Type: application/json

Paramètres de la requête

Les paramètres doivent être fournis dans le corps de la requête sous forme de JSON :

email (string, requis) : L’adresse email de l’utilisateur.
password (string, requis) : Le mot de passe de l’utilisateur.

Exemple de requête

curl -X POST https://api.pre-etat.date/account/auth \
-H "Content-Type: application/json" \
-H "X-Auth-Key: <API_KEY>" \
-d '{
    "email": "jean@gmail.com",
    "password": "qwertyuio"
}'

Réponses

200 OK

L’authentification a réussi. Un token JWT est retourné.

Exemple de réponse :

{
  "message": "Connexion russie", 
  "payload": {
    "access_token": "..token.."
  }, 
  "success": true
}

400 Bad Request

La requête est incorrecte ou des informations sont manquantes. Les cas typiques incluent :

Absence de l’email ou du mot de passe dans la requête, ou clé API.
Compte non validé (un email de validation est envoyé).

Exemple de réponse :

{
  "message": "La clé API n'est pas valide", 
  "payload": null, 
  "success": false
}

401 Unauthorized

L’authentification a échoué. Les informations de connexion fournies sont invalides (email ou mot de passe incorrect).

Exemple de réponse :

{
  "message": "Informations de connexion invalides.", 
  "payload": null, 
  "success": false
}

Notes supplémentaires

Pour utiliser les endpoints protégés par la clé API, incluez la clé API dans l’en-tête X-Auth-Key.
Le token JWT retourné doit être inclus dans l’en-tête Authorization de toutes les requêtes ultérieures pour accéder aux ressources protégées de l’API.

Exemple d’utilisation du token d’API

curl -X POST https://api.pre-etat.date/... \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer $TOKEN" \
    -H "X-Auth-Key: $API_KEY" \
    -d '{}'