Documentation fonctionnelle et API KWISATZ
Gestion de la fidélité ZEROSIX
L’interface ZEROSIX externalise la gestion de la fidélité dans une plateforme cloud. KWISATZ recherche ou crée les clients, transmet les tickets encaissés, puis récupère les points, la cagnotte et les bons voucher à afficher ou utiliser en caisse.
Réponse directe
Conseil technicien général
1. Repères de version
Les références de version ci-dessous sont conservées comme repères documentaires. Les menus, options et comportements doivent être contrôlés sur la version et la sérialisation réellement installées ; une évolution plus récente peut avoir modifié le fonctionnement.
2. Licence et disponibilité
La dépendance de licence mentionnée dans ce document provient des sources. Sa disponibilité peut varier selon la version, la sérialisation, le partenaire ou l’installation ; faites-la valider techniquement avant de modifier l’environnement.
3. Distinguer abonnements et fidélité
Les abonnements correspondent à des prestations disponibles et consommables dans les tickets lorsque le client est sélectionné. Ils ne doivent pas être confondus avec les points ou passages de fidélité. Un devis, une facture, un rendez-vous ou un mouvement financier ne constitue pas, à lui seul, une consommation d’abonnement.
4. Distinguer KWISATZ des opérations externes
Un enregistrement dans KWISATZ ne prouve pas automatiquement qu’une opération a été exécutée dans un système externe : débit ou remboursement TPE, mouvement physique d’espèces, envoi de SMS ou d’e-mail, ou action réalisée sur une plateforme.
5. Protection des données
6. Architecture de l’interface
| Composant | Rôle |
|---|---|
| KWISATZ Vente directe | Identifie le client, saisit et encaisse le ticket, propose l’utilisation de la cagnotte ou des vouchers. |
| API ZEROSIX | Recherche, crée et met à jour les contacts ; reçoit les tickets ; calcule les points, avantages et soldes. |
| Fiche client KWISATZ | Conserve les données locales et le champ CLOUD_ID qui relie la fiche au contact ZEROSIX. |
| Back-office ZEROSIX | Définit le programme, les seuils, exclusions, promotions, vouchers et règles marketing. |
| Règlement KWISATZ | Comptabilise l’utilisation d’un voucher ou de la cagnotte selon le mode retenu. |
7. Prérequis
- compte commerçant ZEROSIX opérationnel ;
- URL API fournie par ZEROSIX ;
- token valide ;
- programme Cycle ou Cagnotte défini dans l’abonnement ;
- module ZEROSIX actif sur les caisses concernées ;
- version KWISATZ récente, idéalement 3.56R4 ou supérieure pour les nouveaux réglages ;
- connexion Internet stable et HTTPS autorisé ;
- mode de règlement dédié aux vouchers ;
- clavier et écran de caisse permettant la recherche ZEROSIX ;
- politique de consentement et d’information des clients.
8. Configurer la plateforme ZEROSIX
- Ouvrez Outils > Préférences.
- Sélectionnez l’onglet Divers.
- Ouvrez la section Vente directe.
- Dépliez Plateforme ZEROSIX (Fidélité cloud).
- Cochez Activer.
- Renseignez l’adresse de l’API dans URL.
- Renseignez la clé dans Token.
- Sélectionnez le type de programme souscrit.
- Choisissez le mode de règlement des bons voucher.
- Définissez le mode de reprise des vouchers.
- Configurez les exclusions promotion et remise.
- Réglez le minimum de caractères de recherche et les temporisations.
- Enregistrez puis relancez KWISATZ si la version l’exige.
| Zone | Rôle | Conseil |
|---|---|---|
| Activer | Met en service la fidélité ZEROSIX. | Ne l’activer qu’après saisie de l’URL et du token. |
| URL | Adresse de l’API ZEROSIX. | Utiliser exactement l’adresse fournie, sans inventer de suffixe. |
| Token | Clé d’authentification du compte commerçant. | Conserver le secret hors des documents publics. |
| Type de programme | Cycle ou Cagnotte. | Doit correspondre au contrat ZEROSIX. |
| Bon voucher — règlement associé | Règlement KWISATZ utilisé pour la valeur des vouchers. | Créer un règlement distinct et contrôlé comptablement. |
| Reprise voucher par vente négative | Remplace la valeur financière du règlement par des lignes négatives. | Tester la TVA et le pont comptable avant activation. |
| Exclure les ventes en promotion | Marque les lignes concernées pour exclusion du calcul ZEROSIX. | Comparer avec les règles du back-office. |
| Exclure les ventes avec remise | Écarte les lignes remisées du calcul de fidélité selon le paramétrage. | Tester remises de ligne et de pied. |
| Recherche client — nombre minimum | Nombre de caractères avant l’appel de recherche. | Minimum et défaut documentés : 3 ; augmenter si les réponses sont trop larges. |
| Connexion — Timeout | Délai maximal d’établissement de la connexion. | Minimum et défaut documentés : 10 secondes. |
| Requêtes — Timeout | Délai maximal de lecture d’une réponse API. | Minimum et défaut documentés : 10 secondes. |
PREFERENCES.INI. Ce repère interne ne doit pas être modifié directement. Faites analyser et valider le réglage par un technicien KWISATZ après sauvegarde et relevé de la configuration.9. Choisir le bon type de programme
| Programme | Fonctionnement | Utilisation en caisse |
|---|---|---|
| Cycle | Le client cumule des points. Lorsqu’un seuil est atteint, ZEROSIX crée automatiquement un voucher. | Le voucher peut accorder une valeur fixe ou un pourcentage de remise. |
| Cagnotte | Les points sont convertis en euros placés immédiatement dans une cagnotte. | La cagnotte peut régler totalement ou partiellement le ticket comme un porte-monnaie électronique. |
10. Rechercher, créer et associer les clients
Le champ identifiant cloud interne constitue la liaison principale entre
la fiche locale KWISATZ et le contact ZEROSIX.
Client déjà présent dans ZEROSIX
- Ouvrez la recherche ZEROSIX depuis la caisse.
- Saisissez au moins le nombre de caractères configuré.
- Sélectionnez le client dans les résultats.
- Si aucune fiche KWISATZ n’est associée, KWISATZ peut créer une fiche locale.
- Si une fiche est déjà liée, elle est actualisée.
- Contrôlez le
CLOUD_IDaprès validation.
Client absent des deux bases
- Utilisez la fonction de création depuis ZEROSIX/KWISATZ.
- Complétez la fiche client.
- Recueillez le consentement ou l’information nécessaire.
- Validez.
- KWISATZ crée le contact sur la plateforme et la fiche locale.
- Vérifiez que
CLOUD_IDcontient l’identifiant retourné.
Client présent dans les deux bases sans association
- Recherchez le client dans ZEROSIX.
- Utilisez la fonction d’association.
- Sélectionnez la fiche KWISATZ existante.
- Confirmez l’association.
- Vérifiez qu’aucune nouvelle fiche n’a été créée.
Client présent uniquement dans KWISATZ
- Sélectionnez la fiche KWISATZ.
- Utilisez la fonction de création dans ZEROSIX.
- Contrôlez le téléphone et les informations obligatoires.
- Validez puis contrôlez le
CLOUD_ID.
CLOUD_ID.
11. Qualité des données clients
- normaliser les numéros de téléphone ;
- éviter les espaces et séparateurs incohérents pour les portables lorsque le connecteur exige un format précis ;
- contrôler nom, prénom, courriel et date de naissance selon les règles du programme ;
- rechercher les fiches sans
CLOUD_ID; - rechercher plusieurs fiches KWISATZ portant le même
CLOUD_ID; - faire corriger par ZEROSIX les doublons existant côté plateforme ;
- ne jamais remplacer manuellement un
CLOUD_IDsans procédure.
12. Traiter un ticket avec fidélité ZEROSIX
- Recherchez et sélectionnez le client ZEROSIX.
- Contrôlez la situation fidélité affichée.
- Saisissez les produits normalement.
- Appliquez les promotions et remises prévues.
- Appuyez sur Total.
- Utilisez la cagnotte ou un voucher si proposé.
- Encaissez le solde.
- Finalisez le ticket.
- KWISATZ transmet le ticket à ZEROSIX.
- ZEROSIX recalcule les points ou la cagnotte.
- KWISATZ récupère et imprime la nouvelle situation.
13. Gérer les bons voucher
Dans le programme Cycle, la plateforme transforme les points en voucher lorsqu’un seuil est atteint. Un voucher peut être exprimé en euros ou en pourcentage.
- Sélectionnez le client.
- Saisissez les articles.
- Appuyez sur Total.
- KWISATZ affiche les vouchers disponibles.
- Sélectionnez le bon à utiliser.
- Contrôlez sa valeur, son type et sa validité.
- Validez.
- Encaissez le reste éventuel.
- Vérifiez le code ZEROSIX imprimé sur le ticket.
- Contrôlez que le voucher n’est plus disponible ensuite.
Mode classique
Le voucher est comptabilisé avec le règlement KWISATZ associé.
Mode « Reprise voucher par vente négative »
Le règlement est conservé avec un montant nul pour imprimer le code du voucher, tandis que KWISATZ insère des lignes négatives qui réduisent le total. La ventilation est calculée selon le prorata de TVA représenté sur le ticket.
- voucher en valeur : articles système de famille
ZCOUPON01XX; - voucher en pourcentage : articles système de famille
ZCOUPON02XXselon la version ; XXreprésente le code de TVA rattaché ;- quantité générée :
-1.
14. Utiliser le programme Cagnotte
Dans le programme Cagnotte, les points sont convertis en euros et peuvent être utilisés sans attendre la génération d’un voucher.
- Sélectionnez un client lié par
CLOUD_ID. - Contrôlez le solde retourné par ZEROSIX.
- Saisissez le ticket.
- À Total, choisissez le montant de cagnotte à utiliser si la version le permet.
- Vérifiez qu’il ne dépasse ni le solde ni le total autorisé.
- Encaissez le complément.
- Finalisez le ticket.
- Contrôlez le nouveau solde côté caisse et plateforme.
15. Promotions, remises et exclusions
Les options d’exclusion permettent de signaler à ZEROSIX que certaines ventes ne doivent pas produire d’avantage.
| Option | But | Test conseillé |
|---|---|---|
| Exclure les ventes bénéficiant d’une promotion | Ne pas cagnotter ou attribuer de points sur les lignes promotionnelles. | Comparer un article au tarif normal et le même article en promotion. |
| Exclure les ventes bénéficiant d’une remise | Écarter les lignes ou tickets remisés selon le fonctionnement documenté. | Tester remise de ligne, remise globale et remise client. |
| Catégorie transmise | Permet des exclusions ou règles dans le back-office ZEROSIX. | Vérifier que le code famille attendu est transmis. |
Is_Promo
selon les options afin que ZEROSIX applique ses règles d’exclusion.
16. Multi-caisses et licences
Chaque caisse autonome qui communique directement avec ZEROSIX doit disposer du module et de sa propre configuration opérationnelle.
| Poste | Module ZEROSIX |
|---|---|
| Caisse autonome recherchant les clients et transmettant les tickets | Requis. |
| Caisse autonome utilisant cagnotte et vouchers | Requis. |
| Back-office sans encaissement | Généralement non requis pour l’exploitation de caisse. |
| Poste rattaché à une architecture centralisée | À valider selon la licence et l’architecture réelle. |
17. Données personnelles et sécurité
- informer le client du transfert de ses données vers la plateforme ;
- ne transmettre que les données nécessaires au programme ;
- protéger le token API ;
- limiter l’accès aux préférences ;
- ne pas publier les
CLOUD_IDréels ; - prévoir la correction, l’opposition et la suppression selon les procédures contractuelles ;
- anonymiser les tickets transmis au support ;
- ne pas conserver le token dans les journaux ou captures ;
- documenter la source de vérité de chaque champ client ;
- contrôler les doublons avant une campagne marketing.
18. Recette avant mise en production
- Tester l’URL et le token.
- Rechercher un client existant.
- Créer un client absent des deux bases.
- Associer un client existant dans les deux bases.
- Créer dans ZEROSIX un client déjà présent dans KWISATZ.
- Contrôler les
CLOUD_ID. - Encaisser un ticket sans promotion.
- Encaisser un ticket promotionnel.
- Encaisser un ticket avec remise.
- Contrôler les points ou la cagnotte.
- Utiliser un voucher en valeur.
- Utiliser un voucher en pourcentage.
- Tester le mode vente négative.
- Tester une utilisation partielle de cagnotte.
- Tester une coupure Internet avant et après Total.
- Comparer le ticket KWISATZ et l’historique ZEROSIX.
19. Diagnostic rapide
Erreur lors de l’appel create contact
La recherche ne renvoie rien
La recherche renvoie trop de clients
Une fiche client est créée en double
CLOUD_ID.
Si le client existe dans les deux bases sans liaison, utilisez la fonction
d’association au lieu d’une nouvelle création.
Plusieurs clients partagent le même téléphone
CLOUD_ID.
Demandez à ZEROSIX de corriger les doublons côté plateforme si nécessaire.
Le ticket n’apparaît pas dans ZEROSIX
Le ticket apparaît deux fois dans ZEROSIX
Les points ne sont pas calculés
La cagnotte n’est pas proposée
Aucun voucher n’est proposé à Total
Le voucher est comptabilisé avec un mauvais montant
Une promotion produit quand même des points
Erreur de timeout
La situation fidélité n’est pas imprimée
Le back-office fonctionne mais une caisse autonome non
20. Actions à éviter
- inverser URL et token ;
- copier le token d’un autre commerçant ;
- créer un client avant d’avoir effectué une recherche ;
- remplacer manuellement un
CLOUD_ID; - fusionner des clients sur le seul critère du téléphone ;
- activer simultanément deux fidélités incompatibles ;
- forcer un voucher après une erreur API ;
- réenvoyer un ticket validé sans vérifier son UID ;
- activer la vente négative sans test de TVA ;
- modifier les tickets fiscaux pour corriger des points.
21. Liste de contrôle
- Le compte ZEROSIX est opérationnel.
- L’URL et le token sont dans les bonnes zones.
- L’interface est activée.
- Le programme Cycle ou Cagnotte est correct.
- Le règlement voucher est configuré.
- Le mode classique ou vente négative est validé.
- Les exclusions promotions/remises sont testées.
- Les seuils et timeouts sont adaptés.
- Les clients sont liés par
CLOUD_ID. - Les créations et associations ne génèrent pas de doublons.
- Les points, vouchers et cagnotte concordent.
- Chaque caisse autonome concernée possède le module.
- Les règles RGPD et la protection du token sont appliquées.
22. Évolutions documentées
| Période | Évolution |
|---|---|
| 2021–2022 | Consolidation de l’API ZEROSIX, identification de l’application et gestion des délais de communication. |
| Avril 2023 | Prise en charge des vouchers en valeur ou pourcentage et du mode de reprise par ventes négatives. |
| 2023–2024 | Amélioration des exclusions promotion/remise et du contenu transmis à la plateforme. |
| Juin 2025 — branche 3.56 | Ajout du type de programme Cycle/Cagnotte, du seuil de recherche client et des temporisations dans les préférences. |
| Versions récentes | Développements pour utiliser directement la cagnotte et amélioration du rapprochement des tickets, promotions et UID. |
23. Sources documentaires
- Tutoriel KWISATZ — Interface de fidélité ZEROSIX.
- Version 3.56R4 — Programme Cycle, Programme Cagnotte, seuil de recherche et timeouts.
- Suivi de développement KWISATZ — vouchers, ventes négatives et exclusions promotion/remise.
- Base support KWISATZ — création, association, doublons clients et
CLOUD_ID. - Base support KWISATZ — architecture multi-caisses et nombre de modules.