AXIUM Identity API

Présentation

Démarrage rapide

Nouveau sur cette API ? Voici les 3 étapes à connaître avant de coder.

Flux d'authentification

• L'application cliente fournit son client_id et client_secret.
• AXIUM Identity valide l'application.
• L'utilisateur est authentifié via Keycloak.
• Les rôles et permissions sont chargés.
• Un access_token et un refresh_token sont retournés.

Connexion utilisateur

Authentifie un utilisateur et retourne ses tokens, rôles et permissions.

Paramètres

Exemple de requête

POST /api/oauth/token
Content-Type: application/json

{
    "client_id": "axium-stock",
    "client_secret": "xxxxxxxx",
    "username": "byao@sifogroup.com",
    "password": "123456"
}

Réponses possibles

Cliquez sur un code pour voir le format exact retourné par l'API.

{
    "success": true,
    "token_type": "Bearer",
    "access_token": "eyJhbGciOiJSU.....",
    "refresh_token": "eyJhbGciOiJI.....",
    "expires_in": 300,
    "user": {
        "id": 1,
        "email": "byao@sifogroup.com",
        "first_name": "Benjamin",
        "last_name": "YAO",
        "active": true
    },
    "roles": [
        "ROLE_USER",
        "ROLE_ADMIN",
        "ROLE_COMMERCIAL"
    ],
    "permissions": [
        "CREATE_USER",
        "CREATE_CARD",
        "CREATE_VOYAGE",
        "VIEW_USER_DASHBOAD"
    ],
    "permissionsWithDescriptions": [
        {
            "name": "CREATE_USER",
            "description": "Création d'un utilisateur ADMIN"
        },
        {
            "name": "CREATE_CARD",
            "description": "Création d'une carte carburant"
        },
        {
            "name": "CREATE_VOYAGE",
            "description": "Création d'un voyage"
        },
        {
            "name": "VIEW_USER_DASHBOAD",
            "description": "Consultation du tableau de bord Utilisateur"
        }
    ]
}

{
    "success": false,
    "error": {
        "code": "INVALID_CLIENT",
        "message": "Client inconnu.",
        "details": []
    }
}

{
    "success": false,
    "error": {
        "code": "INVALID_CLIENT_SECRET",
        "message": "Client secret invalide.",
        "details": []
    }
}

{
    "success": false,
    "error": {
        "code": "AUTHENTICATION_FAILED",
        "message": "Identifiants incorrects.",
        "details": []
    }
}

{
    "success": false,
    "error": {
        "code": "AUTHENTICATION_FAILED",
        "message": "Utilisateur invalide.",
        "details": []
    }
}

{
    "success": false,
    "error": {
        "code": "APP_ACCESS_DENIED",
        "message": "Accès refusé. Votre compte ne dispose pas des autorisations requises pour utiliser cette application.",
        "details": []
    }
}

Rafraîchir un token

Génère un nouveau access_token à partir du refresh_token, sans redemander les identifiants.

Paramètres

Exemple de requête

POST /api/oauth/refresh
Content-Type: application/json

{
    "refresh_token": "eyJhbGciOi..."
}

Réponse — 200 OK

{
    "success": true,
    "token_type": "Bearer",
    "access_token": "eyJhbGciOi...",
    "refresh_token": "eyJhbGciOi...",
    "expires_in": 300
}

Déconnexion

Révoque le refresh token et termine la session utilisateur côté Keycloak.

Paramètres

Exemple de requête

POST /api/oauth/logout
Content-Type: application/json

{
    "refresh_token": "eyJhbGciOi..."
}

Réponse — 200 OK

{
    "success": true,
    "message": "Déconnexion réussie."
}

Utiliser le token

Toutes les API protégées nécessitent l'ajout du header HTTP suivant à chaque requête :

Authorization: Bearer {access_token}

Créer un utilisateur

Crée un nouvel utilisateur et l'associe à l'application cliente appelante. Si un utilisateur possédant déjà cet email existe, il est mis à jour et l'application cliente lui est simplement ajoutée (aucune duplication de compte).

Paramètres

Exemple de requête

POST /api/user/create
Content-Type: application/json

{
    "client_id": "op0a1a84-f8a6-461a-graz1-fd32fdcbf2cb",
    "email": "byao@sifogroup.com",
    "firstName": "Benjamin",
    "lastName": "YAO",
    "phone": "+2250709502322",
    "password": "123456"
}

Réponses possibles

Cliquez sur un code pour voir le format exact retourné par l'API.

{
    "success": true,
    "message": "Utilisateur créé avec succès.",
    "client": "Axium Stock",
    "user": {
        "id": 14,
        "email": "byao@sifogroup.com"
    }
}

{
    "success": true,
    "message": "Utilisateur modifié avec succès.",
    "client": "Axium Stock",
    "user": {
        "id": 7,
        "email": "byao@sifogroup.com"
    }
}

{
    "success": false,
    "message": "Client application invalide."
}

Uploader un avatar

Permet à une application cliente de mettre à jour la photo de profil d'un utilisateur. Le fichier est stocké et traité entièrement côté AXIUM Identity — l'application cliente ne fait que transmettre le fichier reçu depuis son formulaire.

Paramètres

Exemple de requête

POST /api/user/avatar/upload
Content-Type: multipart/form-data

client_id: axium-stock
email: byao@sifogroup.com
avatar: (fichier binaire, ex: photo.jpg)

Réponses possibles

Cliquez sur un code pour voir le format exact retourné par l'API.

{
    "success": true,
    "message": "Avatar mis à jour avec succès.",
    "client": "Axium Stock",
    "user": {
        "id": 1,
        "email": "byao@sifogroup.com",
        "avatar_url": "https://api.identity.optimumci.com/uploads/avatars/0190f3c2-....jpg"
    }
}

{
    "success": false,
    "message": "Aucun fichier avatar fourni."
}

{
    "success": false,
    "message": "Client application invalide."
}

{
    "success": false,
    "message": "Utilisateur introuvable."
}

{
    "success": false,
    "message": "L'image ne doit pas dépasser 2 Mo."
}

Format des erreurs

Toutes les erreurs retournées par AXIUM Identity utilisent ce format JSON uniforme, quel que soit l'endpoint :

{
    "success": false,
    "error": {
        "code": "ERROR_CODE",
        "message": "Message utilisateur",
        "details": []
    }
}

Codes d'erreur possibles

Codes HTTP