Export FEC 🧪 [BETA]

⚠️ API en BETA / préversion. Le contrat (endpoints, paramètres, codes retour, format de réponse) peut évoluer sans préavis avant la disponibilité générale (GA). Ne pas utiliser en production sans validation préalable avec Cegid.

Présentation générale de l'API et finalité fonctionnelle

Ces API permettent de démarrer un export FEC d'un dossier, d'en suivre le statut, puis de télécharger le fichier généré :

Démarrage de la demande : POST /exportFec
Suivi du statut de la demande : GET /statutExport
Téléchargement du fichier généré : GET /fichierExport

Le fonctionnement est asynchrone : exportFec renseigne un demandeId qu'il faut ensuite utiliser pour interroger statutExport (polling), puis fichierExport une fois le statut Terminee obtenu.

Le dossier est identifié uniquement par le paramètre de requête codeDossier (codeIBS). L'export démarré par cette API est toujours un export provisoire (FORMAT-FEC, sans validation des écritures).

POST `/exportFec` 🧪 BETA

Cette API démarre une demande d'export FEC pour un dossier.

Cas d'usage

Cette API permet de démarrer la génération d'un export au format FEC provisoire pour une période donnée, sur le dossier désigné par codeDossier.
Si sousDossierId est renseigné, l'export est limité à ce sous-dossier (établissement). S'il est omis, un seul FEC regroupe toutes les écritures du dossier (tous les sous-dossiers).

Procédure

Il faut appeler un endpoint permettant de démarrer la demande d'export FEC :

POST https://api.cegid.com/loop-api-publiques/exportFec?codeDossier=\<codeIBS>

Route	Méthode http	Description
/exportFec	POST	Démarre une demande d'export FEC

Paramétrage de l'appel

Méthode http pour la demande : POST

Header(s) attendu(s) obligatoire(s) de la demande

Champ	Description
Ocp-Apim-Subscription-Key	Subscription key
x-apikey	API Key & Secret

Paramètres de requête (query)

Name	Type	Description	Exemple	Obligatoire
codeDossier	String	Code du dossier (codeIBS)	CEGID003	Oui

Paramètres du corps (body)

Champ	Type	Description	Exemple	Obligatoire
sousDossierId	UUID	Identifiant du sous-dossier / établissement. Si omis : export de tout le dossier (tous les sous-dossiers).	42213456-ebd5-496f-bda8-a7966a45201f	Non
periodeObjectId	UUID	Identifiant de la période	1cb682a7-b7e7-4700-a0a3-f1325b15be42	Oui
dateFinGeneration	String	Date de fin de génération au format ISO (YYYY-MM-DDTHH:mm:ssZ)	2025-01-31T00:00:00Z	Oui

Exemple de body (un sous-dossier)

{
    "sousDossierId": "42213456-ebd5-496f-bda8-a7966a45201f",
    "periodeObjectId": "1cb682a7-b7e7-4700-a0a3-f1325b15be42",
    "dateFinGeneration": "2025-01-31T00:00:00Z"
}

Exemple de body (tout le dossier)

{
    "periodeObjectId": "1cb682a7-b7e7-4700-a0a3-f1325b15be42",
    "dateFinGeneration": "2025-01-31T00:00:00Z"
}

Code retour

En cas de succès

Code retour http de la réponse : 202 - la demande est acceptée et mise en file d'attente.

En cas d'échec

Code	Description
400	Requête invalide (paramètre ou corps manquant/incorrect)
429	Quota dépassé - une demande d'export FEC provisoire existe déjà pour ce dossier aujourd'hui
404	Dossier inconnu (`codeDossier` introuvable) ou sous-dossier principal introuvable pour un export global (sans `sousDossierId`)
409	Quota dépassé — une demande d'export FEC provisoire existe déjà pour ce dossier aujourd'hui
422	Paramètres métier invalides (`periodeObjectId` inconnu, `sousDossierId` inconnu, combinaison incohérente, `dateFinGeneration` invalide)
503	Résolution du dossier temporairement indisponible (annuaire amont en défaut)

Structure du retour

Champ	Type	Description
demandeId	UUID	Identifiant de la demande d'export FEC, à utiliser avec `statutExport` et `fichierExport`

Exemple de réponse

{
    "demandeId": "1cb682a7-b7e7-4700-a0a3-f1325b15be42"
}

GET `/statutExport` 🧪 BETA

Cette API permet de consulter le statut d'une demande d'export FEC.

Cas d'usage

Cette API permet de suivre l'avancement d'une demande d'export FEC démarrée par exportFec, par interrogation périodique (polling), jusqu'à obtention d'un statut final (Terminee ou EnErreur).

Procédure

Il faut appeler un endpoint permettant de récupérer le statut d'une demande :

GET https://api.cegid.com/loop-api-publiques/statutExport?codeDossier=\<codeIBS>&demandeId=<uuid>

Route	Méthode http	Description
/statutExport	GET	Retourne le statut d'une demande d'export FEC

Paramétrage de l'appel

Méthode http pour la demande : GET

Header(s) attendu(s) obligatoire(s) de la demande

Champ	Description
Ocp-Apim-Subscription-Key	Subscription key
x-apikey	API Key & Secret

Paramètres de requête (query)

Name	Type	Description	Exemple	Obligatoire
codeDossier	String	Code du dossier (codeIBS)	CEGID003	Oui
demandeId	UUID	Identifiant de la demande d'export FEC (retourné par `exportFec`)	1cb682a7-b7e7-4700-a0a3-f1325b15be42	Oui

Code retour

En cas de succès

Code retour http de la réponse : 200

En cas d'échec

Code	Description
400	Requête invalide - `demandeId` absent
404	Demande inconnue ou n'appartenant pas à l'utilisateur

Structure du retour

Champ	Type	Description
statut	String	Statut de la demande : `Acceptee`, `EnCours`, `Terminee` ou `EnErreur`

Codes possibles :

`statut`	Signification
`Acceptee`	Demande en file d'attente
`EnCours`	Génération en cours
`Terminee`	Export terminé
`EnErreur`	Échec de l'export

Point d'attention : interroger périodiquement statutExport jusqu'à obtenir Terminee ou EnErreur.

Exemple de réponse

{ "statut": "Acceptee" }

{ "statut": "EnCours" }

{ "statut": "Terminee" }

{ "statut": "EnErreur" }

GET `/fichierExport` 🧪 BETA

Cette API permet de télécharger le fichier résultant d'une demande d'export FEC terminée.

Cas d'usage

Cette API permet, une fois la demande au statut Terminee, de récupérer le fichier .zip du FEC généré.

Procédure

Il faut appeler un endpoint permettant de récupérer le fichier d'une demande terminée :

GET https://api.cegid.com/loop-api-publiques/fichierExport?codeDossier=\<codeIBS>&demandeId=<uuid>

Route	Méthode http	Description
/fichierExport	GET	Retourne le fichier d'une demande d'export FEC terminée

Paramétrage de l'appel

Méthode http pour la demande : GET

Header(s) attendu(s) obligatoire(s) de la demande

Champ	Description
Ocp-Apim-Subscription-Key	Subscription key
x-apikey	API Key & Secret

Paramètres de requête (query)

Name	Type	Description	Exemple	Obligatoire
codeDossier	String	Code du dossier (codeIBS)	CEGID003	Oui
demandeId	UUID	Identifiant de la demande d'export FEC (retourné par `exportFec`)	1cb682a7-b7e7-4700-a0a3-f1325b15be42	Oui

Code retour

En cas de succès

Code retour http de la réponse : 302 - redirection vers le fichier .zip à télécharger (en-tête Location), sans contenu JSON.

En cas d'échec

Code	Description
404	Demande inconnue ou n'appartenant pas à l'utilisateur
409	Le fichier n'est pas encore prêt (export non terminé)
410	L'export a échoué ou le fichier n'est plus disponible
503	Le lien de téléchargement est temporairement indisponible

Points d'attention

Export provisoire (FORMAT-FEC) uniquement via cette API publique.
Isolation : un utilisateur B ne peut pas télécharger le demandeId créé par un utilisateur A (retour 404).
Une seconde demande exportFec le même jour pour le même dossier retourne 409 (quota export provisoire).

Configuration APIM (backends as-code)

Les chemins publics (client) et les backends Loop sont déclarés dans le dépôt Loop-Api-Management-Docs :

Contrat public : APIM/Loop/services/export-fec.json (OpenAPI importé dans APIM).
Routage backend : APIM/backends/operations.json — modèle backendUrl = https://{envHost}{backend-path} (voir APIM/backends/README.md).

Méthode	public-path (client)	backend-path (Loop)
POST	`/exportFec`	`/collaborateur/service/publicapi/service/fec`
GET	`/statutExport`	`/collaborateur/service/publicapi/service/fec`
GET	`/fichierExport`	`/collaborateur/service/publicapi/service/fec`

Les public-path correspondent aux clés OpenAPI (sans paramètres de requête). Le backend-path est identique sur tous les environnements ; seul l'hôte change (INTE, TEST_FW, ENV5, etc.).

Après merge sur staging, exécuter le pipeline APIM sur l'environnement cible : génération du swagger → import APIM → application des backends (apply-backends).

Table of Contents

Export FEC 🧪 [BETA]

Présentation générale de l'API et finalité fonctionnelle

POST /exportFec 🧪 BETA

Cas d'usage

Procédure

Paramétrage de l'appel

Exemple de body (un sous-dossier)

Exemple de body (tout le dossier)

Code retour

Structure du retour

Exemple de réponse

GET /statutExport 🧪 BETA

Cas d'usage

Procédure

Paramétrage de l'appel

Code retour

Structure du retour

Exemple de réponse

GET /fichierExport 🧪 BETA

Cas d'usage

Procédure

Paramétrage de l'appel

Code retour

Configuration APIM (backends as-code)

POST `/exportFec` 🧪 BETA

GET `/statutExport` 🧪 BETA

GET `/fichierExport` 🧪 BETA