Créez une expérience sereine pour ZenClub
Chaque expérience ZenClub est une petite application web autonome. Elle s’exécute sur sa propre origine dans un cadre isolé et communique avec la ville par un SDK léger. Vous gardez votre moteur, votre framework et votre rythme de publication.
Comment tout s’articule
- La plateforme ouvre votre URL d’entrée dans un cadre isolé et transmet sa propre origine ainsi qu’un identifiant d’instance dans le fragment de l’URL.
- Votre code appelle
connect(). Après une courte négociation, chaque appel transite par unMessagePortprivé. Votre cadre n’appelle jamais directement les serveurs ZenClub. - La plateforme vérifie chaque appel selon les capacités approuvées pour votre version exacte, puis enregistre ou présente le résultat pour vous.
Ce que le SDK vous apporte
- Le thème du visiteurLes couleurs, le mode clair ou sombre, la typographie et la réduction des animations arrivent sous forme de variables CSS et sont actualisés en direct.
- Sauvegardes fiablesDes emplacements de sauvegarde versionnés avec révisions, détection des conflits, nouvelles tentatives sûres et sauvegarde automatique.
- Temps mesuréVous indiquez si l’expérience est en cours. La plateforme mesure le temps : vous n’avez pas à le compter vous-même.
- Moments et badgesPermettez aux visiteurs de garder l’image d’un instant paisible et demandez des badges que la plateforme vérifie.
- Actions d’en-têteAjoutez le son, le redémarrage, l’aide et vos propres actions dans l’en-tête de la plateforme.
- Langue et heureLa langue et le fuseau horaire du visiteur sont fournis dans le contexte afin que votre expérience puisse l’accueillir dans ses propres mots.
Ce qui reste privé
Les plugins ne reçoivent jamais d’adresse e-mail, d’identifiant de compte, de jeton ni de cookie. Le contexte contient uniquement le nom affiché, la langue, le fuseau horaire, le niveau d’adhésion, le thème, une préférence sonore facultative et un choix approuvé d’enregistrement de la ville. Le cadre ne peut pas ouvrir de fenêtres contextuelles, afficher des boîtes de dialogue, envoyer des formulaires ni naviguer dans la page.
Guides
- Démarrage rapideCréez un projet, reliez-le à un hôte de test et enregistrez votre première progression.
- Manifeste et autorisationsDéclarez qui vous êtes, où vous résidez et les capacités dont vous avez besoin.
- Référence du SDKToutes les méthodes, options, limites et tous les codes d’erreur du SDK client.
- Cycle de vie et sauvegardesNégociation, pause et reprise, rapports de maintien, révisions et nouvelles tentatives.
- Hébergement et examenHébergez votre expérience, passez l’examen et publiez de nouvelles versions en toute sûreté.
Obtenir le SDK
@zenclub/sdk est un package de modules ES sans dépendance, avec des types TypeScript. Nous le partageons avec les créateurs avec lesquels nous travaillons. Écrivez-nous pour nous parler de votre idée ; nous vous enverrons la version actuelle et proposerons un créneau d’examen.