Intégration · Comptabilité et ERP

Relier votre logiciel métier à Cegid : Loop, XRP Sprint, XRP Flex et leurs API

Cegid ne propose pas une API unique mais une API par gamme, documentée sur le portail Cegid Developers ou dans l'aide du produit. Pour une PME, les cas courants sont l'envoi d'écritures et de justificatifs dans le dossier Cegid Loop de son expert-comptable, et l'interrogation de Cegid XRP Sprint par ses Web API, avec une clé générée sur Cegid Life.

L'essentiel

  • Cegid expose les API de Cegid Loop aux partenaires et aux clients pour relier Cegid Loop à d'autres solutions : écritures, tiers, plan de comptes, documents, balance.
  • Une clé d'API Cegid Loop est générée par l'administrateur du cabinet comptable sur Cegid Life, puis activée dans le Loop Hub du cabinet.
  • L'import d'écritures dans Cegid Loop accepte les formats JSON, FEC, TRA et personnalisé ; seul le JSON permet de rattacher la pièce jointe.
  • L'API documentaire de Cegid Loop accepte un fichier de 50 Mo au plus par requête et signale un doublon par le statut W.
  • Les Web API de Cegid XRP Sprint utilisent une clé d'API et un secret créés sur Cegid Life, échangés contre un jeton transmis en Bearer.

Quel Cegid, quelle API ?

Chaque gamme Cegid a sa documentation et sa clé : identifiez d'abord le produit concerné et qui en détient les accès. Le portail Cegid Developers centralise une partie des API, avec leur description et leur documentation ; d'autres documentations figurent dans l'aide en ligne des produits.

Produit CegidUtilisé parInterface documentéeQui ouvre l'accès
Cegid LoopCabinets d'expertise comptableAPI Loop : écritures, imports, documents, tiers, plan de comptes, journaux, codes TVA, balance, synchronisationL'administrateur du cabinet, sur Cegid Life puis dans le Loop Hub
Cegid ExpertCabinets d'expertise comptableAPI Cegid Expert, avec un jeton OAuth 2.0 obtenu à partir d'une clé d'APIL'administrateur du cabinet, sur Cegid Life
Cegid XRP SprintEntreprises équipées des modules Finance, MTS ou HRWeb API Finance, MTS et HR ; Cegid Data Service pour publier des vues en ODataL'administrateur, sur Cegid Life et dans Quick Launch Manager
Cegid XRP FlexPME, selon CegidPage produit : connexion « via nos API » et connecteurs natifsCegid ou l'intégrateur, documentation à demander
Cegid eConnectPlateformes agréées de facturation électroniqueAPI entre eConnect et la plateforme agrééeLes équipes techniques des plateformes

Si vous cherchez à remplacer plutôt qu'à relier, la page alternatives à Cegid compare les options. Cegid détient aussi EBP depuis juillet 2024, dont les API sont décrites sur la page connecter EBP.

Alimenter le dossier Cegid Loop de votre expert-comptable

C'est le cas le plus courant pour une PME : le cabinet tient la comptabilité dans Cegid Loop, et votre logiciel métier produit des ventes ou des achats que quelqu'un ressaisit. La documentation de Cegid indique que ces API sont exposées « aux partenaires et aux clients » pour intégrer Cegid Loop à d'autres solutions.

L'accès se prépare avec le cabinet, en trois étapes décrites par Cegid :

  1. l'administrateur du cabinet génère une clé d'API sur Cegid Life : la clé Standard est toujours disponible, la clé Cabinet seulement si le cabinet a acheté ce service, et la clé comme son secret ne s'affichent qu'une fois ;
  2. il active cette clé dans le Loop Hub du cabinet ;
  3. une clé d'abonnement, générée sur le portail Cegid Developers après souscription au service « Cegid Developers - APIs Cegid Loop » sur Cegid Life, ouvre l'usage des API.

La clé d'API, suivie de son secret, se transmet ensuite dans l'en-tête x-apikey. Pour les essais, Cegid donne aux partenaires accès à un environnement de test nommé CEGIDPARTENAIRES. La documentation conseille enfin une politique de nouvelle tentative, certaines API pouvant être ponctuellement indisponibles.

Écritures, justificatifs, synchronisation : ce que font les API Loop

Import d'écritures. Quatre formats sont acceptés : JSON, FEC, TRA et personnalisé (CSV). Le JSON gère les pièces jointes et les modes de paiement, alors que le FEC et le TRA ne permettent pas de lier une pièce. Le format personnalisé suppose un modèle créé au préalable dans Cegid Loop. Pour les imports FEC, TRA et personnalisé, les fichiers se déposent soit à une URL authentifiée sur le stockage de votre choix, soit dans un stockage Azure dont l'adresse est fournie par l'API getFileUrlDeposit. L'avancement se suit par les statuts et l'historique des imports.

Dépôt de justificatifs. L'API documentaire transmet un fichier à PIA, qui crée ensuite automatiquement les écritures dans le dossier. Seuls les PDF, JPG et PNG sont traités ; un fichier par requête, 50 Mo au plus. Les paramètres donnent le code du dossier (context), le nom du fichier et, pour une facture, son sens (PURCHASE ou SALE). La réponse renvoie le statut C pour un document collecté, W pour un doublon, qui n'est pas traité.

Synchronisation sortante. Pour lire la comptabilité au fil de l'eau, Cegid Loop ne décrit pas de webhooks mais une synchronisation par abonnement : chaque insertion, modification ou suppression sur les objets comptables suivis produit un fichier JSON, déposé dans un stockage Azure Blob ou AWS S3. Seuls les exercices ouverts et le dernier exercice clôturé sont initialisés, et des rapports comptent les enregistrements traités.

D'autres API couvrent le lettrage et le délettrage, la ventilation analytique, l'export FEC, les tiers (clients, fournisseurs, salariés, divers), les journaux, les codes TVA et la balance.

Cegid XRP Sprint : Web API et Cegid Data Service

Pour une entreprise équipée de Cegid XRP Sprint, la documentation publique de Cegid décrit des Web API Finance, MTS et HR consommées avec une clé d'API. La mise en place se fait à deux endroits :

  • sur Cegid Life, un administrateur crée la clé d'API et son secret, visible une seule fois ;
  • dans Quick Launch Manager, il crée un utilisateur de type clé d'API et lui ouvre l'accès aux applications CegidFinance, CegidMTS ou CegidBHR, dossier par dossier.

La clé et le secret s'échangent contre un jeton d'accès, placé ensuite après le mot Bearer. Une fois l'utilisateur migré vers Cegid Account, la connexion aux Web API par un utilisateur LDAP n'est plus possible : une liaison ancienne fondée sur un compte LDAP est à revoir.

Cegid Data Service (CDS) complète ce dispositif pour la lecture : c'est un outil web qui publie, à partir de vues, des Web API REST au protocole OData, avec les options $select, $filter, $orderby, $skip, $top et $count. L'accès dépend de l'abonnement au bouquet CDS, les autorisations se donnent par dossier, et une requête archivée ne peut plus être réactivée.

Quatre flux types entre une PME et Cegid

  1. Les ventes du jour vers le cabinet. Un logiciel de location de matériel clôture sa journée ; le service importe les écritures de ventes en JSON, factures jointes, dans le dossier Cegid Loop, puis contrôle le statut de l'import.
  2. Les factures fournisseurs reçues par e-mail. Un robot relève la boîte des achats et dépose chaque PDF par l'API documentaire, avec le sens PURCHASE ; un statut W signale un document déjà reçu. Voir comment automatiser la saisie.
  3. La trésorerie du matin. Une vue CDS publiée sur Cegid XRP Sprint alimente chaque matin un tableau de bord de pilotage, sans export de fichier.
  4. Une copie comptable pour l'analyse. La synchronisation Loop dépose les changements dans votre stockage S3 ; un traitement les charge dans votre base d'analyse, dans l'ordre de leurs horodatages.

Les points de vigilance avec les API Cegid

  • La propriété des clés. Pour Cegid Loop, la clé appartient au cabinet : convenez par écrit de qui la génère, qui peut la révoquer et qui prévenir en cas d'incident.
  • Le dossier visé. Selon Cegid, un code de dossier erroné n'empêche pas le traitement d'un document, qui n'apparaît alors pas dans le dossier : le service contrôle ce code avant chaque envoi.
  • Les limites d'appels. Cegid publie des limites pour son API de facture électronique eConnect : 500 requêtes par minute par client, ou 20 par minute par identité quand aucun client n'est identifié, avec une réponse 429 et un en-tête Retry-After à respecter. Pour les autres API, les pages consultées n'en mentionnent pas : le service espace quand même ses appels.
  • Les reprises. File d'attente, nouvelles tentatives espacées, journal de chaque import et de chaque dépôt, alerte en cas d'échecs répétés : c'est ce qui permet d'éliminer les doubles saisies sans en créer.
  • Les données personnelles. Les API Loop exposent aussi des tiers salariés : ne synchronisez que les champs nécessaires, et inscrivez le flux au registre des traitements.

Connecteur, intégrateur ou développement sur mesure ?

Pour Cegid XRP Flex, la page produit évoque une architecture cloud ouverte connectable « via nos API », des connecteurs natifs (cités dans un témoignage client) et une interface native avec des logiciels de trésorerie comme Cegid Exabanque : vérifiez d'abord avec votre intégrateur ce qui existe, et demandez la documentation technique, absente de la page produit. Côté facture électronique, l'API eConnect s'adresse aux équipes techniques des plateformes agréées, pas aux logiciels métier, qui passent par la plateforme choisie par l'entreprise : voir la facture électronique dans un logiciel métier.

Le développement sur mesure se justifie quand le flux part d'un outil propre à votre activité. YMHB Web construit alors le service d'intégration après un cadrage avec vous et, selon le cas, votre cabinet ou votre intégrateur. Vous recevez le code en technologies standard, déposé chez vous, la liste des API et formats utilisés, le journal des échanges et la procédure de renouvellement des clés, le tout à vous au paiement intégral.

Questions fréquentes

Cegid a-t-il une API publique ?

Cegid publie plusieurs API, une par gamme, sur le portail Cegid Developers et dans l'aide de certains produits : Cegid Loop et Cegid Expert pour les cabinets comptables, les Web API de Cegid XRP Sprint, l'API eConnect pour la facture électronique. L'accès demande des clés : pour Cegid Loop, Cegid Expert et Cegid XRP Sprint, elles se génèrent sur Cegid Life, avec l'accord de l'administrateur concerné.

Mon logiciel peut-il envoyer des écritures dans le Cegid Loop de mon expert-comptable ?

Oui, si le cabinet l'accepte. L'administrateur du cabinet génère une clé d'API sur Cegid Life et l'active dans son Loop Hub ; votre logiciel peut alors importer des écritures au format JSON, FEC, TRA ou personnalisé, ou déposer des justificatifs en PDF, JPG ou PNG. Des quatre formats d'import de Cegid Loop, seul le JSON permet de joindre la pièce à l'écriture.

Cegid Loop envoie-t-il des webhooks ?

La documentation de Cegid Loop ne décrit pas de webhooks. Pour suivre les changements, Cegid Loop propose une synchronisation par abonnement : chaque insertion, modification ou suppression sur les objets comptables suivis produit un fichier JSON, déposé dans un stockage Azure Blob ou AWS S3 désigné par l'abonné. Le service d'intégration lit ensuite ces fichiers dans l'ordre.

Quelle taille de fichier l'API documentaire de Cegid Loop accepte-t-elle ?

Selon la documentation Cegid, l'API documentaire de Cegid Loop accepte un seul fichier par requête, de 50 Mo au plus. Tout type de fichier peut être envoyé, mais seuls les PDF, JPG et PNG sont traités par PIA, qui crée ensuite les écritures dans le dossier. Un statut W dans la réponse signale un doublon, qui n'est pas traité.

Les Web API de Cegid XRP Sprint acceptent-elles encore un compte LDAP ?

Plus après la migration vers Cegid Account. La documentation Cegid indique qu'une fois l'utilisateur migré, la connexion aux Web API de Cegid XRP Sprint avec un utilisateur LDAP n'est plus possible. Il faut alors créer une clé d'API et son secret sur Cegid Life, puis un utilisateur de type clé d'API dans Quick Launch Manager, avec accès aux dossiers concernés.

À lire aussi

Sources

  1. Cegid Developers, Cegid Loop, Getting started (API pour partenaires et clients, x-apikey, environnement CEGIDPARTENAIRES)
  2. Cegid Developers, Cegid Loop, How to get an APIKey ? (clés Standard et Cabinet sur Cegid Life)
  3. Cegid Developers, Cegid Loop, Comment générer une subscription key ?
  4. Cegid Developers, Cegid Loop, sommaire de la documentation des API
  5. Cegid Developers, Cegid Loop, Import des écritures comptables (JSON, FEC, TRA, personnalisé)
  6. Cegid Developers, Cegid Loop, Document management, Store document (PIA, 50 Mo, statuts C et W)
  7. Cegid Developers, Cegid Loop, Data Synchronisation (abonnements, Azure Blob, AWS S3)
  8. Cegid Developers, Cegid Expert, Démarrage (clé d'API générée sur Cegid Life, jeton OAuth 2.0, clé de souscription, portail Cegid Developers)
  9. Cegid Developers, eConnect, connexion d'une plateforme agréée externe
  10. Cegid Developers, eConnect, Limitation de débit (500 requêtes par minute par client, 20 par identité sans client, 429, Retry-After)
  11. Cegid, aide en ligne XRP Sprint, Utilisation des Web API sur sociétés migrées Cegid Account (PDF)
  12. Cegid, aide en ligne XRP Sprint, Cegid Data Service (CDS) (PDF)
  13. Cegid, page produit Cegid XRP Flex (PME, API, connecteurs, interface avec Cegid Exabanque)
  14. Cegid, communiqué « Cegid confirme l'acquisition d'EBP » (17 juillet 2024)

Prêt à démarrer ?

Décrivez-nous votre situation, pas une liste de fonctionnalités.

Réponse sous un jour ouvré, en général par téléphone. Si un outil du marché suffit, nous vous le dirons.

Premier échange sans engagementCadrage avant chiffrage

AppelerDécrire mon problème