Skip to content

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/login

Authentifie l'utilisateur et retourne un token d'accès ainsi qu'un refresh token.

Body (JSON)

NomTypeRequisDescription
usernameStringouiNom d'utilisateur
passwordStringouiMot 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/refreshToken

Renouvelle le token d'accès à partir d'un refresh token valide.

Body (JSON)

NomTypeRequisDescription
refreshTokenStringouiRefresh 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/logout

Invalide le token d'accès courant.

Headers

NomTypeRequisDescription
x-access-tokenStringouiClé 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"
}

Coefficy — API externe