Ce formulaire permet de gérer l'inscription et la configuration auprès des services CEGID pour l'Opérateur de Dématérialisation des factures (OD), également appelé Concentrateur eFacture, ainsi que pour la Plateforme de Dématérialisation Partenaire (PDP) pour chaque établissement ayant un code SIRET distinct.
Le processus d'inscription se déroule en plusieurs étapes, chaque étape étant associée à une action spécifique déclenchée par un bouton.
L'utilisateur qui réalise ce processus doit être lié à un compte Cegid Account et doit être abonné aux services de "Gestion des utilisateurs - Administration" pour son identifiant de contrat (code SIC).
En outre, le service « Cegid Opérateur de Dématérialisation » doit figurer dans la liste des services associés à l'identifiant du contrat. Ce service est activé pour le client lors de la souscription à l'offre Opérateur de Dématérialisation des factures.
Cette interface permet également d'enregistrer une URL publique de callback pour l'utilisation des webhooks d'achats ou de ventes.
Cela signifie que le service « Opérateur de Dématérialisation » sera autorisé à envoyer des notifications à l'URL publique de callback chaque fois qu'un événement pertinent se produit. Par exemple, lorsqu'une facture change de statut sur la PDP, l'information est transmise l'Opérateur de Dématérialisation. Ce dernier enverra une requête à cette URL spécifiée pour signaler le changement. Le nouveau statut sera ensuite enregistré dans une table de la base de données, puis lu et propagé dans l'ERP là où cela est nécessaire.
Données
Identifiant du produit
La liste des produits qui sont disponibles pour l'inscription sont définis dans le paramètre : IDPGTPDP.
Nom de l'inscription
Cette information est libre.
Ce nom apparaîtra sur la Plateforme de Dématérialisation Partenaire (PDP) en lien avec l'inscription pour l'identifiant du contrat-SIRET.
Identifiant du contrat
Identifiant du compte utilisé pour accéder aux applications de Cegid.
Pour Cegid XRP Ultimate On Demand, cet identifiant est proposé et ne peut pas être modifié.
Il doit être saisi pour Cegid XRP Ultimate OnPremise.
Un client ne peut avoir qu'un seul identifiant de contrat (code SIC).
Informations relatives à l'établissement
Les informations à renseigner pour l'établissement sont :
- le code établissement. Il doit être saisi uniquement si l'identifiant du produit est celui livré par Cegid XRP Ultimate. Les autres informations liées à l'établissement seront proposées et sont modifiables. Pour un identifiant produit externe les informations relatives à l'établissement sont saisies manuellement ;
- le code SIRET de l'établissement ;
- le nom de l'inscription ;
- l'adresse complète.
Informations relatives au représentant du SIRET
Le représentant de l'établissement se caractérise par :
- son adresse e-mail ;
- son prénom ;
- son nom.
Plateforme de dématérialisation
Plateforme de Dématérialisation Partenaire sur laquelle l'inscription est réalisée.
Les plateformes disponibles sont définies dans le paramètre : PDPGTPDP.
Statut d'inscription
Le statut permet de suivre l'avancement du processus d'inscription.
Les valeurs disponibles sont définies dans le paramètre : STAGTPDP.
Message associé au statut
Le message associé au statut.
Il est renseigné uniquement lorsqu'une étape de l'inscription a échoué. Lorsque le problème est résolu, le statut change et le message disparait.
Session ID
Le numéro de session est affecté lors du lancement de l'action "Ouvrir une session".
Customer ID
Le customer ID est affecté sur l'action "Obtenir un Customer ID".
Si le customer ID a déjà été retourné mais qu'il n'a pas été affecté, il faut relancer l'action "Ouvrir une session". Cette action ne retournera pas un nouveau numéro de session mais le Customer ID.
Identifiant et mot de passe
Si le code produit correspond au produit CEGID, l'utilisateur et le mot de passe sont stockés dans les mots de passe.
L'identifiant de l'API Key et le mot de passe ne sont renseignés que pour l'inscription d'un produit autre que Cegid XRP Ultimate.
Attention, ces informations ne sont pas stockées en base, il faut donc les conserver manuellement. Elles seront nécessaire pour la finalisation de l'inscription à la plateforme et également pour les inscriptions aux webhooks.
Webhooks
Webhooks Achats
Permet de s'inscrire aux webhooks des achats
Webhooks Ventes
Permet de s'inscrire aux webhooks des ventes
Url publique de callback
Cette Url correspond à une adresse accessible par les services de l'Opérateur de Dématérialisation sur laquelle les notifications sont reçues.
Pour Cegid XRP Ultimate On Demand, cette adresse est proposée et n'est pas modifiable.
Cette Url est obligatoire et n'est pas modifiable dés lors qu'au moins une inscription aux webhooks est faite. Elle doit être la même pour les webhooks achats et ventes si les deux inscriptions sont demandées.
Statut d'inscription webhook Achats
Le statut permet de suivre l'avancement du processus de l'inscription aux webhooks des achats
Les valeurs disponibles sont définies dans le paramètre : SWAGTPDP.
Message associé au statut du webhook Achats
Le message associé au statut du webhook des achats.
Il est renseigné uniquement lorsqu'une étape de l'inscription aux webhooks des achats a échoué. Lorsque le problème est résolu, le statut change et le message disparait.
Statut d'inscription webhook Ventes
le statut permet de suivre l'avancement du processus de l'inscription aux webhooks des ventes
Les valeurs disponibles sont définies dans le paramètre : SWVGTPDP.
Message associé au statut du webhook Ventes
Le message associé au statut du webhook des ventes.
Il est renseigné uniquement lorsqu'une étape de l'inscription aux webhooks des ventes a échoué. Lorsque le problème est résolu, le statut change et le message disparait.
Obtenir une API Key
Cette action permet d'obtenir une API Key pour l'inscription aux webhooks des achats et/ou des ventes.
Une fois l'API Key obtenue, l'inscription aux webhooks peut être lancée.
Inscription webhook Achats
Pour lancer l'inscription aux webhooks des achats il faut une API Key valide pour les webhooks.
Si le code produit ne correspond pas à un produit Cegid XRP Ultimate, et que les informations concernant l'identifiant et le mot de passe de la clé API ne sont pas renseignées, il est nécessaire de les saisir en utilisant ceux obtenus et conservés lors de l'inscription à la Plateforme de Dématérialisation Partenaire.
Une fois l'inscription effectuée, le statut des webhooks des achats change.
Si une erreur se produit, des traces sont générées dans la consultation des traces du onboarding.
Inscription webhook Ventes
Pour lancer l'inscription aux webhooks des ventes il faut un token valide et une API Key pour les webhooks.
Si le code produit ne correspond pas à un produit Cegid XRP Ultimate, et que les informations concernant l'identifiant et le mot de passe de la clé API ne sont pas renseignées, il est nécessaire de les saisir en utilisant ceux obtenus et conservés lors de l'inscription à la Plateforme de Dématérialisation Partenaire.
Une fois l'inscription effectuée, le statut des webhooks des ventes change.
Si une erreur se produit, des traces sont générées dans la consultation des traces du onboarding.
Paramètres standard
Boutons poussoirs
Obtenir un token
Cette action permet d'obtenir un token d'authentification suite à une connexion à Cegid Account. Une fois l'opération effectuée, une page s'ouvre pour indiquer si elle a réussi.
Veuillez noter qu'il est impératif d'être administrateur du compte CEGIDLIFE pour réaliser cette opération.
Si le token est obtenu avec succès, vous reviendrez à l'écran d'Onboarding OD/PDP où le statut d'inscription passera à "Token obtenu" et le bouton "Ouvrir une session" sera activé.
En cas d'échec, le statut reste inchangé et des traces de l'opération sont enregistrées dans la consultation des traces du processus d'Onboarding OD/PDP.
Pour continuer les étapes suivantes, un token valide est nécessaire.
Le token devient invalide dans les situations suivantes :
- l'écran d'Onboarding OD/PDP a été fermé ;
- une recherche a été effectuée après l'obtention du token ;
- le temps de validité du token a expiré.
Lorsque le token n'est plus valide, vous pouvez simplement en demander un nouveau via le bouton "Obtenir un token", qui reste accessible. Notez que le token n'est pas conservé à la fermeture de l'écran.
Ouvrir une session
Cette action permet l'ouverture d'une session afin d'obtenir ultérieurement le Customer ID.
Pour cela, le point d'accès au service de l'OD doit être paramétré dans le référencement des services avec l'identifiant : CEGID_EFACTURE.
Services pour un clients :
- Pour un accès au service de production : "https://efacture.cegid.cloud/api/".
- Pour un accès au service de recette : "en attente"
Services réservés les équipes Cegid :
- Pour un accès en intégration : "https://inteapi-efacture.cegid.cloud/api/" ;
- Pour un accès en Stagging : "https://testapi-efacture.cegid.cloud/api/".
Le numéro de session obtenu est enregistré et le statut change.
En cas d'échec, le statut n'évolue pas. Des traces sont générées dans la consultation des traces du onboarding.
Pour pouvoir ouvrir une session le token doit être valide.
Obtenir un customer ID
Cette action permet d'obtenir un customer ID nécessaire pour s'inscrire à la Plateforme de Dématérialisation Partenaire et aux webhooks.
Cette action n'est accessible que si le numéro de session a bien été obtenu.
Le point d'accès à l'OD doit être paramétré dans le référencement des services avec l'identifiant : CEGID_EFACTURE.
Une nouvelle page HTLM permettant une connexion à Cegid PDP s'ouvre pour effectuer l'inscription du représentant pour le SIRET sur la plateforme.
Si le CustomerID est obtenu avec succès, vous reviendrez à l'écran d'Onboarding OD/PDP où le statut d'inscription passera à "Customer ID obtenu" et le bouton "Obtenir une API Key" sera activé.
Si le customer ID n'est pas renseigné et le statut n'a pas changé, deux situations peuvent se présenter :
- une erreur a été signalée dans la page HTML. Vous devez alors résoudre le problème et relancer la demande de Customer ID ;
- Le Customer ID a été attribué mais non enregistré dans la base de données. Dans ce cas, vous devez ouvrir à nouveau une session pour obtenir le Customer ID et faire avancer le statut à l'étape suivante.
Pour pouvoir obtenir un customer ID le token doit être valide.
Obtenir une API Key
Cette action permet d'obtenir une API Key (utilisateur et mot de passe) qui sont nécessaires à l'inscription sur la Plateforme de Dématérialisation Partenaire.
Cette action n'est accessible que si le customer ID a bien été obtenu.
L'Url d'inscription doit être paramétrée dans le référencement des services avec l'identifiant : CEGIDLIFE.
L'API key renvoyée est :
- stockée dans les mots de passe si l'identifiant du produit correspond à Cegid XRP Ultimate ;
- affiché temporairement dans l'écran de l'inscription. Il faut alors conserver ces informations pour les affecter lors de la finalisation de l'inscription si elles ne sont plus présentes dans l'écran ou lors de l'inscription aux webhook.
Le statut change et il est alors possible de finaliser l'inscription. Des traces sont générées dans la consultation des traces du onboarding.
Pour lancer cette action le token doit être valide.
Finaliser l'inscription
Cette action permet finaliser l'inscription sur la Plateforme de Dématérialisation Partenaire.
Cette action n'est accessible que si l'API key a été obtenue. Le statut change.
Des traces sont générées dans la consultation des traces du onboarding.
Pour lancer cette action le token doit être valide.