📘 Documentation API – Objets Courrier du Portail Clients du CAM

1. Introduction

Bienvenue dans la documentation de l’API des Objets Courrier du Portail Clients du CAM.

• Objectif : Fournir un contrat clair pour la consultation et la configuration des objets de courrier. Ces objets définissent les types de documents qui peuvent être échangés dans le portail.
• Audience : Développeurs front-end, administrateurs du système.
• 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 Objets Courrier nécessite un jeton d'authentification valide. Le jeton doit être inclus dans l'en-tête Authorization de chaque requête.

Headers :

Authorization: Bearer <token>

4. Endpoints Objets Courrier

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

📄 Récupérer une liste paginée d'objets de courrier

Récupère une liste paginée de tous les objets de courrier.

GET /api/app/objet-courrier

Headers :

Authorization: Bearer <token>

Paramètres (Query) :

Paramètre	Type	Description
SkipCount	integer	Nombre d'éléments à sauter pour la pagination. (Défaut: 0)
MaxResultCount	integer	Nombre maximal d'éléments à retourner. (Défaut: 10)

Réponse (200 OK) :

{
  "totalCount": 15,
  "items": [
    {
      "id": 1,
      "typeObjet": "ATTASS",
      "description": "Attestation d'assurance",
      "utilisablePourLiasse": true,
      "typeAffectation": "Obligatoire",
      "lienFichier": null
    }
  ]
}

📄 Récupérer tous les objets de courrier (sans pagination)

Récupère la liste complète de tous les objets de courrier, triée par typeObjet.

GET /api/app/objet-courrier/list-all

Headers :

Authorization: Bearer <token>

Réponse (200 OK) :

[
  {
    "id": 1,
    "typeObjet": "ATTASS",
    "description": "Attestation d'assurance",
    "utilisablePourLiasse": true,
    "typeAffectation": "Obligatoire",
    "lienFichier": null
  },
  {
    "id": 2,
    "typeObjet": "IDCNI",
    "description": "Carte d'identité",
    "utilisablePourLiasse": false,
    "typeAffectation": "Rien",
    "lienFichier": "/api/app/objet-courrier/2/fichier-modele"
  }
]

📄 Récupérer un objet de courrier par son ID

Récupère un objet de courrier spécifique en utilisant son identifiant.

GET /api/app/objet-courrier/{id}

Headers :

Authorization: Bearer <token>

Paramètres (Path) :

Paramètre	Type	Description
id	integer	L'identifiant unique de l'objet de courrier.

Réponse (200 OK) :

{
  "id": 1,
  "typeObjet": "ATTASS",
  "description": "Attestation d'assurance",
  "utilisablePourLiasse": true,
  "typeAffectation": "Obligatoire",
  "lienFichier": null
}

✏️ Mettre à jour un objet de courrier

Met à jour la configuration d'un objet de courrier existant. Seules les propriétés utilisablePourLiasse et typeAffectation peuvent être modifiées.

PUT /api/app/objet-courrier/{id}

Permissions requises : PortailClients.ObjetsCourrier.Update

Headers :

Authorization: Bearer <token>

Paramètres (Path) :

Paramètre	Type	Description
id	integer	L'identifiant de l'objet à mettre à jour.

Body (ObjetCourrierUpdateDto):

{
  "utilisablePourLiasse": true,
  "typeAffectation": "Obligatoire"
}

Réponse (200 OK) :

Retourne l'objet ObjetCourrierDto mis à jour.

❌ Opérations non supportées

Les opérations suivantes ne sont pas autorisées via l'API et lèveront une exception. La synchronisation des objets se fait via un processus en arrière-plan.

• POST /api/app/objet-courrier (Création)
• DELETE /api/app/objet-courrier/{id} (Suppression)

5. Modèles de Données

ObjetCourrierDto

Représente l'objet de transfert de données pour un objet de courrier.

Champ	Type	Description
id	integer	L'identifiant unique de l'objet.
typeObjet	string	Code unique identifiant le type d'objet (ex: "ATTASS").
description	string	Description détaillée de l'objet.
utilisablePourLiasse	boolean	true si cet objet est utilisable pour les liasses.
typeAffectation	string	Définit si l'objet est Obligatoire, Optionnel ou Rien pour une liasse.
lienFichier	string (nullable)	URL pour télécharger le fichier modèle associé, s'il existe.

ObjetCourrierUpdateDto

Représente les données nécessaires pour mettre à jour un objet de courrier.

Champ	Type	Description
utilisablePourLiasse	boolean	Définit si l'objet est utilisable pour les liasses.
typeAffectation	string	Le type d'affectation. Valeurs possibles : Rien, Optionnel, Obligatoire.

6. Gestion des Erreurs

Code HTTP	Signification	Détail
401	Non autorisé	Token invalide, manquant ou expiré.
403	Interdit	L'utilisateur n'a pas la permission requise pour l'opération.
404	Ressource non trouvée	L'objet de courrier avec l'ID spécifié n'existe pas.
500	Erreur serveur	Une erreur interne est survenue (ex: tentative de création/suppression).

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 (GET, GET /list-all) et la mise à jour (PUT) des Objets Courrier.
• Désactivation de la création (POST) et de la suppression (DELETE).

9. Annexes

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