# API Cegid Retail Y2

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 [Connecter avec Cegid Retail Y2](/connectors/fr/pos/cegid/connect-with-cegid-retail-y2.md). Pour la synchronisation des champs client, voir [mapping des champs Cegid Retail Y2](/connectors/fr/pos/cegid/cegid-retail-y2-fields-mapping.md).

### 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 Wallet spécifique.

* **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 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é, comme les détails de la carte ou les points.
* **Documents de vente** expose les reçus 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 Wallet et déclencher des notifications push en temps réel.

<details>

<summary><strong>Exemples concrets</strong></summary>

* 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 du PDF, afin que le document puisse être exposé dans un parcours Wallet.

</details>

### Fonctionnement de l'intégration

The Wallet Crew utilise deux modèles d'intégration avec Cegid Retail Y2. Les appels de service web récupèrent ou mettent à jour les données à la demande. Les notifications métier signalent des é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 du 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 profils, 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 des fiches client, généralement par e-mail.
* `UpdateCustomer` met à jour un profil 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 associés à un client. Cela rend la valeur stockée ou les avantages disponibles accessibles aux 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 servent à 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 documents de vente donne 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 par sa 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. Ensuite, `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 permettent de garder les données Wallet à jour sans attendre une actualisation manuelle. Elles permettent à The Wallet Crew de réagir à des événements tels que des mises à jour de fidélité, des achats ou des commandes.

**Point de terminaison :** `BusinessNotificationSubscriptionService.svc`

**Méthodes utilisées**

* `GetActive` répertorie les abonnements actifs.
* `Mettre à jour` met à jour un abonnement existant.
* `Créez` 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 alignés avec Cegid Retail Y2. Cet alignement est ce qui rend les pass Wallet actuels, fiables et utiles opérationnellement.

### FAQ

<details>

<summary><strong>Le connecteur s'appuie-t-il uniquement sur les notifications ?</strong></summary>

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

</details>

<details>

<summary><strong>Quel service est utilisé pour les bons et cartes cadeaux ?</strong></summary>

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

</details>

<details>

<summary><strong>Quel service génère les PDF de reçu ?</strong></summary>

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

</details>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.thewalletcrew.io/connectors/fr/pos/cegid/cegid-retail-y2-apis.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
