| Cegid Developers

Guide d'utilisation - eConnect CLI

Version 1.0 - Juin 2026

Introduction

Un nouvel outil en mode console a été mis en place pour permettre aux applications externes d'effectuer un onboarding sur Shine uniquement.

Avec ce nouvel outil, vous avez toutes les options nécessaires pour effectuer un onboarding sur une ligne d'adressage.

Cet outil est fourni avec une aide complète, dont le reste de document fourni une explication aussi claire et précise que possible.

Qu'est-ce que eConnect CLI ?

eConnect CLI est un outil en ligne de commande qui permet de créer l'onboarding des applications externes à la plateforme Cegid eConnect pour l'envoi et la réception de factures électroniques.

Cet outil est à destination du propriétaire du compte ou un utilisateur ayant reçu les droits par délégation.

À quoi ça sert ?

✅ Déclarer une nouvelle application externe (par exemple : Zuora, Salesforce, etc.).
✅ Configurer la ligne d'adressage que cette application externe va gérer (SIREN, SIREN_SIRET, SIREN_SUFFIXE ou SIREN_SIRET_CODEROUTAGE).
✅ Générer des clés d'accès (API Keys) pour ces applications.

Installation

Prérequis

Avant de commencer, assurez-vous d'avoir :

✅ Windows 10/11 (ou macOS/Linux).
✅ Un compte Cegid étant propriétaire du service Cegid Opérateur de dématérialisation et membre Cegid Developers - APIs Cegid OD Factures dans Cegid Account.
✅ Une clé de souscription dans Cegid Developers sur le service Cegid OD (ou Cegid OD Sandbox si vous allez vous onboarder sur la plateforme de Sandbox). Pour obtenir cette clé consultez les Questions fréquentes dans ce même document.
✅ Le fichier eConnectCLI.exe (demander à l'équipe Professional Service de Cegid qui vous accompagne).

Installation rapide

Téléchargez le fichier eConnectCLI.exe récupéré auprès l'équipe Professional Service.
Placez-le dans un dossier facile à retrouver (par exemple : C:\Apps\eConnect\)
Ouvrez le Terminal ou l'Invite de commandes Windows
Naviguez vers le dossier ou vous avez installé l'application (par exemple : cd C:\Apps\eConnect\)
Testez l'installation : eConnectCLI.exe --version

Si vous voyez le numéro de version, c'est bon ! ✅

La version actuelle est : 1.0.0

Utilisation pas à pas

Étape 1 : Générer un fichier d'exemple

Avant de connecter une application externe à eConnect, vous devez préparer un fichier avec toutes les informations de l'entreprise nécessaires lors de l'onboarding:

Identification du représentant légal.
Coordonnées de l'entreprise.
Ligne d'adressage gérée par l'application.
identifiants de l'application et du client Cegid

Commande : eConnectCLI.exe extapp sample > mon-entreprise.json

Résultat : Un fichier mon-entreprise.json est créé avec un exemple.

Étape 2 : Personnaliser le fichier

Ouvrez le fichier mon-entreprise.json avec un éditeur de texte (Notepad, VSCode, etc.) et modifiez les informations :

Résultat : Un fichier mon-entreprise.json est créé avec un exemple.

Étape 2 : Personnaliser le fichier

Ouvrez le fichier mon-entreprise.json avec un éditeur de texte (Notepad, VSCode, etc.) et modifiez les informations :

{
  "applicationId": "xrpultimate.externalapp",
  "accountId": "12345678",
  "company": {
    "siren": "123456789",
    "name": "Mon Entreprise",
    "siret": "12345678900001",
    "routingCode": null,
    "suffix": null,
    "address": "1 rue de la Paix",
    "city": "PARIS",
    "zipCode": "75001",
    "organizationRole": "All",
    "regime": "Standard_VAT_Regime_Monthly",
    "activeStartDate": "2026-07-01"
  },
  "representative": {
    "email": "contact@masociete.fr",
    "firstName": "Jean",
    "lastName": "Dupont",
    "country": "FR"
  }
}

📝 Champs à remplir

Champ	Description	Exemple
applicationId	Identifiant unique de l'application	`cegidpmi.externalapp`
		`xrpsprint.externalapp`
		`xrpultimate.externalapp`
		`xrpflex.externalapp`
		`notilus-tne.externalapp`
accountId	Numéro de compte Cegid	`12345678`
company.siren	Numéro SIREN (9 chiffres)	`123456789`
company.name	Nom de l'entreprise	`Ma Société SAS`
company.siret	Numéro SIRET (14 chiffres)	`12345678900001`
company.address	Adresse postale	`1 rue de la Paix`
company.city	Ville	`PARIS`
company.zipCode	Code postal	`75001`
company.organizationRole	Rôle (`All`, `Sender`, ou `Receiver`)	`All`
company.regime	Régime de l'entreprise	`Standard_VAT_Regime_Monthly`
		`Standard_VAT_Regime_Quarterly`
		`Simplified_VAT_Regime`
		`VAT_Exemption_Regime`
company.activeStartDate	Date de début (format AAAA-MM-JJ)	`2026-06-29`
representative.email	Email du contact	`contact@masociete.fr`
representative.firstName	Prénom du contact	`Jean`
representative.lastName	Nom du contact	`Dupont`
representative.country	Pays (code ISO 2 lettres)	`FR`

⚠️ Important :

Respecter le format JSON (guillemets, virgules)

Étape 3 : Déclarer l'application

Une fois le fichier prêt, lancez la commande suivante : eConnectCLI.exe extapp onboard --env sbox --subscription-key "VOTRE_CLE_ICI" --onboarding-file "mon-entreprise.json" --apikey-name "Zuora Integration"

🔧 Paramètres de la commande

Paramètre	Abréviation	Description	Obligatoire
`--env`	`-e`	Environnement (`sbox` pour les tests, `prod` pour la production)	✅ Oui
`--subscription-key`	`-sk`	Votre clé de souscription Cegid Developers	✅ Oui
`--onboarding-file`	`-of`	Chemin vers le fichier JSON	✅ Oui
`--apikey-name`	`-n`	Nom de la clé API (ex: nom de l'application)	❌ Non (par défaut : "External Application")
`--apikey-expiration`	`-x`	Date d'expiration (format AAAA-MM-JJ)	❌ Non (par défaut : +12 mois)

Étape 4 : Authentification

Après avoir lancé la commande, un navigateur web s'ouvre automatiquement.

🌐 Connectez-vous avec votre compte Cegid.
🔙 Retournez dans le terminal.

⏱️ Vous avez 3 minutes pour vous authentifier.

Étape 5 : Récupérer la clé API

Si tout se passe bien, vous verrez s'afficher :

[1/4] Connexion au compte Cegid... 
      Un navigateur va s'ouvrir pour vous authentifier.
[2/4] Déclaration de la ligne d'adressage sur eConnect...
      Un navigateur va s'ouvrir pour finaliser la procédure d'onboarding.
[3/4] Création de la clé API « External Application to eConnect » sur l'environnement 'sbox'...
[4/4] Attribution des droits à la clé API sur la ligne d'adressage...
Opération terminée avec succès !

╔══════════════════════════════════════════════════════════╗
║  INFORMATIONS DE CONNEXION — A CONSERVER IMPERATIVEMENT  ║
╚══════════════════════════════════════════════════════════╝

  Identifiant client (Customer ID)      : [VOTRE CUSTOMERID]
  Statut de l'onboarding                : [STATUT]
  Nom de la clé API                     : [LE NOM DE LA CLE API]
  Identifiant de la clé API (Client ID) : [L'IDENTIFIANT DE LA CLE API]
  Secret de la clé API (Client Secret)  : [LE SECRET DE LA CLE API]

Les valeurs possibles pour le statut sont :
Onboarding_Validated: La ligne d'adressage a été validée par la PA. Elle sera enregistrée dans l'Annuaire Central. Le client est pleinement opérationnel.
Onboarding_Pending: La ligne d'adressage a été enregistrée par la PA, mais une validation concernant l'identité du représentant légal est en attente. La ligne d'adressage ne sera pas enregistrée dans l'Annuaire Central tant que le processus de validation n'aura pas abouti. Le client n'est pas opérationnel.
Onboarding_rejected: La ligne d'adressage a été enregistrée par la PA, mais la validation de l'identité du représentant légal a échoué. La ligne d'adressage ne sera pas enregistrée dans l'Annuaire Central. Le client n'est pas opérationnel.
(Un nouvel onboarding, sur cette même ligne d'adressage, pourrait être effectué avec le bon représentant légal).


ATTENTION : Le secret ne sera plus jamais affiché après cette opération.
Conservez précieusement ces informations et configurez-les dans votre
application externe pour accéder à la plateforme eConnect.

Si une erreur survient, vous verrez un message d'erreur explicite dans la console en rouge :

Échec de l'onboarding : [ERROR_CODE] - [MESSAGE_ERROR]. Opération annulée.

⚠️ IMPORTANT : Conservez ces informations et configurez-les dans votre Application Externe. Elle ne sera plus affichée.

📝 Copiez immédiatement cette clé API est à enregistrer dans l`application externe. Elle sera utilisée par celle-ci pour s'authentifier à eConnect.

🎓 Exemples concrets

Exemple 1 : Test dans l'environnement Sandbox

eConnectCLI.exe extapp onboard ^ --env sbox ^ --subscription-key "ab12cd34ef56..." ^ --onboarding-file "C:\Projets\entreprise.json" ^ --apikey-name "Test Zuora" ^ --apikey-expiration "2027-12-31"

💡 Le caractère ^ permet de continuer la commande sur plusieurs lignes sous Windows.

Exemple 2 : Production avec expiration par défaut

eConnectCLI.exe extapp onboard --env prod --subscription-key "ab12cd34ef56..." --onboarding-file "entreprise.json" --apikey-name "Salesforce Production"

⚠️ Utilisez --env prod seulement après avoir testé dans sbox !

Options supplémentaires

Mode verbeux (pour le diagnostic)

Si vous rencontrez des problèmes, ajoutez --verbose pour voir plus de détails :

eConnectCLI.exe extapp onboard --env sbox --verbose --subscription-key "..." --onboarding-file "entreprise.json"

Affichage détaillé :

[DEBUG] Environnement sélectionné : SBOX [DEBUG] URL de l'API : https://api-sbox.econnect.cegid.com [DEBUG] Port disponible trouvé : 7890 [DEBUG] Redirect URI : http://localhost:7890 [DEBUG] Navigateur ouvert pour l'authentification Cegid. ...

Afficher l'aide

Pour voir toutes les commandes disponibles : eConnectCLI.exe --help

Questions fréquentes (FAQ)

Quelle est la différence entre `sbox` et `prod` ?

sbox (Sandbox) : Environnement de test. Utilisez-le pour vos essais sans risque.
prod (Production) : Environnement réel. À utiliser uniquement après validation.

Où trouver ma clé de souscription ?

Connectez-vous sur developers.cegid.com.
Connectez-vous avec votre compte dans User Profile (en haut a droite).
Allez dans → Subscriptions.
Générez la Subscription Key appartenant au service Cegid OD (ou Cegid OD Sandbox).

💡 Vous NE DEVEZ PAS générer une nouvelle clé à chaque onboarding.
Il faut la créer seulement à la première utilisation.

Problèmes courants

Problème : "HTTP (401)"

Cause : Un problème d'autorisation est survenu.

Solutions :

✅ Vérifiez votre accountId dans votre fichier JSON, vous devez en être le propriétaire sur Cegid Account
✅ Connectez-vous sur Cegid Account
✅ Vérifiez le compte sur lequel vous êtes propriétaire

Problème : "Failed to acquire access token"

Cause : L'authentification n'a pas fonctionné.

Solutions :

✅ Vérifiez que le navigateur s'est ouvert
✅ Connectez-vous dans les 3 minutes
✅ Vérifiez vos identifiants Cegid

Problème : "No available ports found for redirect URI"

Cause : Les ports 7890, 7891 et 7892 sont occupés.

Solutions :

✅ Fermez les autres applications qui utilisent ces ports
✅ Redémarrez votre ordinateur
✅ Contactez votre administrateur réseau

Problème : "Environnement 'xxx' invalide"

Cause : Vous avez utilisé un environnement qui n'existe pas.

Solution : Utilisez uniquement sbox ou prod.

Problème : "Le fichier d'onbarding 'xxx' est introuvable"

Cause : Vous avez utilisé un fichier d'onboarding au format JSON qui n'existe pas.

Solution : Utilisez un fichier existant en vérifiant le chemin d'accès.

Problème : "Erreur de validation du fichier d'onboarding"

Cause : CUSTOMER.ALREADY_ONBOARDED

Solution :

✅ Modifiez votre fichier json, car la ligne d'adressage a déjà été onboardée
✅ Relancez la procédure d'onboarding avec des données mises à jour

Problème : "L'application n'est pas au bon format"

Cause : CUSTOMER.APPLICATION_NOT_REGISTERED

Solution :

✅ Modifiez votre fichier json au niveau de l'applicatioId qui doit se terminer par .externalapp
✅ Vérifiez la liste des applicationId disponibles dans la documentation sur Cegid Developers
✅ Relancez la procédure d'onboarding avec des données mises à jour

Table of Contents

Guide d'utilisation - eConnect CLI

Introduction

Qu'est-ce que eConnect CLI ?

À quoi ça sert ?

Installation

Prérequis

Installation rapide

Utilisation pas à pas

Étape 1 : Générer un fichier d'exemple

Étape 2 : Personnaliser le fichier

Étape 2 : Personnaliser le fichier

📝 Champs à remplir

Étape 3 : Déclarer l'application

🔧 Paramètres de la commande

Étape 4 : Authentification

Étape 5 : Récupérer la clé API

🎓 Exemples concrets

Exemple 1 : Test dans l'environnement Sandbox

Exemple 2 : Production avec expiration par défaut

Options supplémentaires

Mode verbeux (pour le diagnostic)

Afficher l'aide

Questions fréquentes (FAQ)

Quelle est la différence entre sbox et prod ?

Où trouver ma clé de souscription ?

Problèmes courants

Problème : "HTTP (401)"

Problème : "Failed to acquire access token"

Problème : "No available ports found for redirect URI"

Problème : "Environnement 'xxx' invalide"

Problème : "Le fichier d'onbarding 'xxx' est introuvable"

Problème : "Erreur de validation du fichier d'onboarding"

Problème : "L'application n'est pas au bon format"

Quelle est la différence entre `sbox` et `prod` ?