📘 Documentation API – Liasses Documentaires du Portail Clients du CAM

1. Introduction

Cette documentation présente l'API pour la gestion des Liasses Documentaires du Portail Clients du CAM.

• Objectif : Définir un contrat clair pour la consultation des liasses documentaires et des pièces associées.
• Audience : Développeurs front-end, partenaires techniques.
• Version : v1

2. Informations Générales

• Base URL : https://[URL_DE_BASE_DE_VOTRE_API]/
• Protocoles : HTTPS
• Format : JSON
• Authentification : Bearer Token (JWT)

3. Authentification

L'accès aux points de terminaison des liasses documentaires requiert un jeton d'authentification valide, qui doit être inclus dans l'en-tête Authorization de chaque requête.

Headers :

Authorization: Bearer <token>

4. Endpoints Liasse Documentaire

Cette section détaille les points de terminaison spécifiques à la gestion des liasses documentaires.

📂 Récupérer la liste des liasses de l'utilisateur

Récupère la liste de toutes les liasses associées à l'utilisateur actuellement authentifié.

GET /api/app/liasse

Headers :

Authorization: Bearer <token>

Réponse (200 OK) :

[
  {
    "id": "LIASSE-001",
    "nomDossier": "Dossier Prêt Immobilier",
    "creationDate": "2025-07-24T10:00:00Z",
    "statut": "En cours",
    "completion": 50.0,
    "deposeeDepuisDerniereConsultation": true,
    "erreur": null,
    "piecesAttendues": [
      {
        "id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
        "objetCourrier": {
          "id": 101,
          "typeObjet": "IDCNI",
          "description": "Pièce d'identité nationale"
        },
        "statut": "Attendu",
        "motif": null
      }
    ],
    "numeroTiers": "T12345",
    "nomTiers": "Dupont",
    "prenomTiers": "Jean",
    "numeroPret": "P67890",
    "montantOpportunite": 150000.00,
    "opportuniteMiseEnPlace": false
  }
]

📄 Récupérer une liasse documentaire par son ID

Récupère les détails d'une liasse documentaire spécifique par son identifiant. Les pièces avec le statut "Dérogée" sont exclues si l'utilisateur ne dispose pas de la permission PortailClients.Liasses.VoirPieceDerogee.

GET /api/app/liasse/{id}

Paramètres URL :

Paramètre	Type	Description
id	string	L'identifiant unique de la liasse.

Headers :

Authorization: Bearer <token>

Réponse (200 OK) :

{
  "id": "LIASSE-001",
  "nomDossier": "Dossier Prêt Immobilier",
  "creationDate": "2025-07-24T10:00:00Z",
  "statut": "En cours",
  "completion": 50.0,
  "deposeeDepuisDerniereConsultation": true,
  "erreur": "Une pièce est en erreur.",
  "piecesAttendues": [
    {
      "id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
      "objetCourrier": {
        "id": 101,
        "typeObjet": "IDCNI",
        "description": "Pièce d'identité nationale"
      },
      "statut": "Attendu",
      "motif": null
    },
    {
      "id": "b2c3d4e5-f6a7-4b8c-9d0e-1f2a3b4c5d6e",
      "objetCourrier": {
        "id": 102,
        "typeObjet": "ATTASS",
        "description": "Attestation d'assurance"
      },
      "statut": "Validé",
      "motif": "Document conforme."
    }
  ],
  "numeroTiers": "T12345",
  "nomTiers": "Dupont",
  "prenomTiers": "Jean",
  "numeroPret": "P67890",
  "montantOpportunite": 150000.00,
  "opportuniteMiseEnPlace": false
}

📊 Récupérer la liste des liasses pour le tableau de bord (Gestionnaire)

Récupère les liasses de tous les clients gérés par l'utilisateur gestionnaire actuellement connecté. Nécessite la permission PortailClients.Dashboard.Host.

GET /api/app/liasse/dashboard-list

Headers :

Authorization: Bearer <token>

Réponse (200 OK) : La réponse est un tableau de LiasseDto, similaire à celui de la récupération de la liste des liasses de l'utilisateur.

5. Modèles de Données

LiasseDto

Représente l'objet de transfert de données pour une liasse documentaire.

Champ	Type	Description
id	string	L'identifiant unique de la liasse.
nomDossier	string	Le nom descriptif de la liasse.
creationDate	DateTimeOffset	La date de création de la liasse.
statut	string	Le statut calculé de la liasse ("Complet" si toutes les pièces sont validées, sinon "En cours").
piecesAttendues	ICollection<PieceAttendueDto>	La collection des pièces requises pour cette liasse.
numeroTiers	string	Le numéro du tiers associé à la liasse.
nomTiers	string	Le nom du tiers associé à la liasse.
prenomTiers	string	Le prénom du tiers associé à la liasse.
numeroPret	string	Le numéro de prêt associé à la liasse.
montantOpportunite	decimal	Le montant de l'opportunité.
opportuniteMiseEnPlace	bool	Indique si l'opportunité est mise en place.
completion	double	Le pourcentage de complétion de la liasse, basé sur les pièces validées.
deposeeDepuisDerniereConsultation	bool	Indique si une nouvelle pièce a été déposée depuis la dernière consultation.
erreur	string	Un message d'erreur agrégé des pièces.

PieceAttendueDto

Représente une pièce requise dans une liasse.

Champ	Type	Description
id	Guid	L'identifiant unique de la pièce attendue.
objetCourrier	ObjetCourrierDto	Les informations sur le type de document attendu.
statut	string	Le statut actuel de la pièce (ex: "Attendu", "Déposé", "Validé", "Dérogé").
motif	string	Un motif associé au statut (ex: la raison d'un rejet).

ObjetCourrierDto

Décrit le type de document (objet courrier) à fournir.

Champ	Type	Description
id	int	L'identifiant unique de l'objet courrier.
typeObjet	string	Le code unique du type de document (ex: "IDCNI").
description	string	La description détaillée du document.
nomFichier	string	Le nom du fichier modèle associé.
lienFichier	string	Le lien vers le fichier modèle associé.

6. Gestion des Erreurs

Code HTTP	Signification	Détail
401	Non autorisé	Token invalide, manquant ou expiré.
403	Interdit	L'utilisateur n'a pas les droits pour accéder à cette ressource.
404	Ressource non trouvée	La liasse avec l'ID spécifié n'existe pas ou le point de terminaison est incorrect.
500	Erreur serveur	Une erreur interne est survenue.

7. Sécurité

• Toutes les requêtes doivent être en HTTPS.
• Utilisation de tokens JWT pour l'authentification.
• Les permissions sont vérifiées côté serveur pour les opérations de lecture et de mise à jour.

8. Changelog

v1.0.0 (Date de création)

• Création des endpoints pour la consultation des liasses documentaires :
  • GET /api/app/liasse : Récupérer la liste des liasses de l'utilisateur.
  • GET /api/app/liasse/{id} : Récupérer une liasse par son identifiant.
  • GET /api/app/liasse/dashboard-list : Récupérer les liasses pour le tableau de bord gestionnaire.

9. Annexes

• 🔗 Swagger UI : https://[URL_DE_BASE_DE_VOTRE_API]/swagger/index.html
• 📦 Postman Collection : PortailClients API.postman_collection.json
• 📧 Contact support : // TODO