Aller au contenu principal

Introduction

Abonnez-vous aux notifications et mises à jour liées aux produits.

Plus d'informations sur l'interface utilisateur du module https://doc.oneentry.cloud/docs/category/events

🎯 Que fait ce module ?​

Le module Events vous permet de faire s'abonner les utilisateurs aux notifications de produits - comme un email lorsque qu'un produit est de nouveau en stock, ou une alerte lorsque le prix baisse. Vous configurez les événements dans le panneau d'administration OneEntry ; le SDK gère qui est abonné à quoi.

Considérez-le comme un système d'abonnement aux produits - les utilisateurs s'abonnent à des produits spécifiques (ou à des formulaires) et reçoivent des notifications lorsque quelque chose change.

🚀 Démarrage rapide​

Initialisez le module à partir de defineOneEntry :


const { Events } = defineOneEntry(
  "your-project-url", {
    "token": "your-app-token"
  }
);

Listez les événements disponibles (public — aucune autorisation requise) :

// Fetch all events configured in the admin panel.
const events = await Events.getAllEvents();

events.forEach((event) => {
  console.log(event);
});

Pour abonner un utilisateur à un événement produit, vous devez d'abord être autorisé, puis appeler subscribeByMarker(marker, productId, langCode?) :

// Requires an authorized user (see AuthProvider).
const ok = await Events.subscribeByMarker("product_price_change", 12345, "en_US");
console.log(ok); // true on success

✨ Concepts clés​

Qu'est-ce qu'un événement produit ?​

Un événement produit est une notification déclenchée par des changements apportés à un produit :

  • Déclencheur - ce qui arrive au produit (par exemple, "de nouveau en stock", "baisse de prix")
  • Notification - ce que reçoivent les abonnés (email ou push)
  • Abonnés - utilisateurs qui se sont inscrits pour recevoir les mises à jour de ce produit
  • Modèle - le contenu du message de notification (configuré dans le panneau d'administration)

Le module prend également en charge les événements de formulaire : abonnez-vous / désabonnez-vous des notifications liées à une soumission de formulaire avec subscribeToForm / unsubscribeFromForm.

Canaux de notification​

CanalDescriptionIdéal pour
EmailEnvoyer des messages par emailAlertes de réapprovisionnement, baisses de prix, bulletins d'information
Notification PushAlertes mobiles/navigateurAlertes urgentes, ventes flash

📋 Ce que vous devez savoir​

Les événements sont configurés dans le panneau d'administration​

Les déclencheurs, canaux et modèles sont configurés dans le panneau d'administration OneEntry. Le SDK ne crée pas d'événements ni ne les déclenche manuellement — les événements se déclenchent automatiquement lorsque les données du produit changent. Le SDK est destiné à lister les événements et à gérer les abonnements.

Autorisation​

getAllEvents() est public. Chaque méthode d'abonnement (getAllSubscriptions, subscribeByMarker, unsubscribeByMarker, subscribeToForm, unsubscribeFromForm, getFormSubscriptions) requiert un utilisateur autorisé — voir AuthProvider.

Variables de modèle​

Utilisez des espaces réservés dans les modèles de notification pour inclure des détails sur le produit comme le nom, le prix et la disponibilité. Les modèles sont modifiés dans le panneau d'administration.

📊 Tableau de référence rapide - Méthodes courantes​

MéthodeCe qu'elle fait
getAllEvents()Obtenir tous les événements disponibles
getAllSubscriptions() 🔐Obtenir tous les abonnements de produits
subscribeByMarker() 🔐S'abonner à un événement produit par marqueur
unsubscribeByMarker() 🔐Se désabonner d'un événement produit par marqueur
subscribeToForm() 🔐S'abonner à un événement de formulaire par marqueur
unsubscribeFromForm() 🔐Se désabonner d'un événement de formulaire par marqueur
getFormSubscriptions() 🔐Obtenir tous les abonnements de formulaire

🔐 Les méthodes nécessitent une autorisation utilisateur — voir AuthProvider. getAllEvents() est public.

❓ Questions fréquentes (FAQ)​

Comment créer ou modifier des événements produits ?​

Les événements sont créés et configurés dans le panneau d'administration OneEntry (section Événements) — configurez les déclencheurs, canaux et modèles là-bas, puis activez l'événement. Le SDK ne fait que lister les événements et gérer les abonnements.

Puis-je déclencher manuellement un événement produit depuis mon code ?​

Non. Le SDK ne prend pas en charge les déclencheurs manuels — les événements se déclenchent automatiquement en fonction des déclencheurs configurés dans OneEntry lorsque les données du produit changent.

Pourquoi l'abonnement échoue-t-il avec une erreur d'autorisation ?​

Les méthodes d'abonnement nécessitent un utilisateur autorisé. Autorisez d'abord via le module AuthProvider, puis appelez subscribeByMarker / subscribeToForm. getAllEvents() fonctionne sans autorisation.

🎓 Meilleures pratiques​

  • Autorisez l'utilisateur avant d'appeler toute méthode d'abonnement.
  • Utilisez des marqueurs d'événements descriptifs (par exemple, product_back_in_stock, product_price_drop).
  • Offrez toujours un chemin de désabonnement facile (unsubscribeByMarker / unsubscribeFromForm).
  • Gérez les erreurs d'abonnement de manière élégante et vérifiez la forme de retour IError.

🔗 Documentation connexe​

  • Module AuthProvider - Autorisez les utilisateurs avant de gérer les abonnements
  • Module Products - Gérez les produits qui déclenchent des événements
  • Module Forms - Formulaires dont les soumissions peuvent être abonnées
  • Module Users - Gérez les utilisateurs qui s'abonnent aux notifications