API Cegid Retail Y2

Aperçu des services web Cegid Retail Y2 et des notifications métier utilisés par le connecteur The Wallet Crew.

Cette page répertorie les services Cegid Retail Y2 utilisés par le connecteur The Wallet Crew. Elle explique le rôle de chaque service, son importance et les méthodes appelées.

Pour la configuration du connecteur, voir Connect with Cegid Retail Y2. Pour la synchronisation des champs client, voir Cegid Retail Y2 fields mapping.

En un coup d'œil

The Wallet Crew se connecte à Cegid Retail Y2 en temps réel via des API et des notifications métier. Chaque service prend en charge un cas d’usage spécifique du Wallet.

• Client prend en charge la recherche, la création, la mise à jour et la gestion du consentement des profils. Il est utilisé pour exposer les données client dans les parcours Wallet.
• Opérations de caisse expose les bons et cartes cadeaux disponibles. Il est utilisé pour afficher les avantages du Wallet et la valeur stockée.
• Fidélité prend en charge la création de cartes de fidélité et la récupération des données de fidélité, telles que les détails de la carte ou les points.
• Documents de vente expose les tickets de caisse et les documents de vente. Il est utilisé pour l'affichage des reçus et les parcours liés au click-and-collect.
• Notifications métier envoie des événements liés à la fidélité, aux achats ou aux commandes. Il est utilisé pour actualiser les données du Wallet et déclencher des notifications push en temps réel.

Exemples concrets

• Une marque crée ou met à jour un client à partir d'un formulaire d'inscription. The Wallet Crew renvoie le profil vers Cegid Retail Y2.
• Une carte de fidélité est créée dans Cegid Retail Y2, puis affichée dans Apple Wallet ou Google Wallet avec les soldes ou avantages actuels.
• Un achat récent déclenche la récupération du reçu ou la génération d'un PDF, afin que le document puisse être exposé dans un parcours Wallet.

Comment fonctionne l’intégration

The Wallet Crew utilise deux modèles d'intégration avec Cegid Retail Y2. Les appels de services web récupèrent ou mettent à jour les données à la demande. Les notifications métier signalent les événements qui doivent déclencher une actualisation ou une notification Wallet.

En pratique, les services client et fidélité prennent en charge l'inscription et le cycle de vie des cartes. Les services d'opérations de caisse et de documents de vente exposent les avantages et les données de transaction. Le point de terminaison de rapport de vente génère des PDF de reçus lorsqu'un fichier de document est nécessaire.

Services utilisés par The Wallet Crew

Client

Le service client prend en charge la recherche de profil, la création, la mise à jour et la synchronisation du consentement. Il constitue la base des parcours Wallet liés au compte.

Point de terminaison : CustomerWcfService.svc

Méthodes utilisées

• SearchCustomerIds recherche les enregistrements clients, généralement par e-mail.
• UpdateCustomer met à jour le profil d'un client existant.
• AddNewCustomer crée un nouveau client dans Cegid Retail Y2.

Opérations de caisse

Le service d'opérations de caisse expose les bons et cartes cadeaux rattachés à un client. Cela permet d'afficher la valeur stockée ou les avantages disponibles dans les expériences Wallet.

Point de terminaison : CashOperationsWcfService.svc

Méthodes utilisées

• GetCustomerAvailableBons récupère les bons ou cartes cadeaux disponibles pour un client.

Fidélité

Les services de fidélité gèrent les cartes de fidélité et les données du programme. Ils sont utilisés pour créer des cartes, récupérer les détails des cartes et déterminer quels programmes sont disponibles.

Points de terminaison : LoyaltyWcfService.svc et LoyaltyEngineLoyaltyEngineService.svc

Méthodes utilisées

• GetCustomerCards renvoie les cartes de fidélité liées à un client.
• GetLoyaltyCard renvoie les détails d'une carte de fidélité spécifique.
• CreateLoyaltyCard crée une nouvelle carte de fidélité dans Cegid Retail Y2.
• GetCardCreationActiveProgramsOnStore renvoie les programmes de fidélité disponibles pour un magasin.

Documents de vente

Le service de document de vente fournit un accès aux enregistrements de transaction. Il est utilisé pour les cas d'usage Wallet qui dépendent des reçus ou des documents liés au click-and-collect.

Point de terminaison : SaleDocumentService.svc

Méthodes utilisées

• GetByKey récupère un document de vente spécifique à l'aide d'une clé.
• GetHeaderList récupère une liste de documents de vente récents.

Rapport de vente

Le service de rapport de vente génère un PDF de reçu. Il est utilisé lorsqu'un document rendu est nécessaire à la place des données brutes du document de vente.

Point de terminaison : SalesExternalReport (REST)

Flux de génération du PDF de reçu

Le flux de reçu comporte trois étapes. D'abord, generatedocument lance la génération du PDF. Puis poll vérifie si le fichier est prêt. Enfin, download récupère le PDF généré.

Méthodes utilisées

• generatedocument lance une nouvelle génération de PDF.
• poll vérifie si le PDF est disponible.
• download télécharge le PDF généré.

Employé

Le service employé récupère les données du personnel du magasin. Il est principalement utilisé lorsqu'une mise en page Wallet doit afficher un conseiller ou un vendeur.

Point de terminaison : EmployeeSalespersonsService.svc

Méthodes utilisées

• GetListDetail renvoie la liste des conseillers d'un magasin.

Notifications métier

Les notifications métier maintiennent les données Wallet à jour sans attendre une actualisation manuelle. Elles permettent à The Wallet Crew de réagir à des événements tels que les mises à jour de fidélité, les achats ou les commandes.

Point de terminaison : BusinessNotificationSubscriptionService.svc

Méthodes utilisées

• GetActive répertorie les abonnements actifs.
• Mettre à jour met à jour un abonnement existant.
• Créer crée un nouvel abonnement.
• Delete supprime un abonnement existant.

Pourquoi ces API sont importantes

Ensemble, ces services permettent à The Wallet Crew de maintenir les profils clients, les données de fidélité, les avantages et les enregistrements de transaction synchronisés avec Cegid Retail Y2. Cet alignement est ce qui rend les passes Wallet actuels, fiables et utiles sur le plan opérationnel.

FAQ

Le connecteur s'appuie-t-il uniquement sur les notifications ?

Non. Le connecteur utilise des appels API directs pour lire et écrire les données, et des notifications métier pour réagir aux événements en quasi temps réel.

Quel service est utilisé pour les bons et les cartes cadeaux ?

CashOperationsWcfService.svc est utilisé à cette fin via GetCustomerAvailableBons.

Quel service génère les PDF de reçu ?

SalesExternalReport génère le PDF. SaleDocumentService.svc est utilisé séparément pour récupérer les données du document de vente et les listes de documents.