Crea una experiencia tranquila para ZenClub
Cada experiencia de ZenClub es una pequeña aplicación web independiente. Funciona en su propio origen dentro de un marco aislado y se comunica con la ciudad mediante un SDK sencillo. Conservas tu motor, tu entorno y tu ritmo de publicación.
Cómo encaja todo
- La plataforma abre la URL de entrada en un marco aislado y pasa su origen y un identificador de instancia en el fragmento de la URL.
- Tu código llama a
connect(). Tras un breve saludo, cada llamada viaja por unMessagePortprivado. Tu marco nunca llama directamente a los servidores de ZenClub. - La plataforma comprueba cada llamada según las capacidades aprobadas para tu versión exacta y luego guarda, registra o presenta el resultado por ti.
Lo que te ofrece el SDK
- El tema de quien visitaLos colores, el modo claro u oscuro, la tipografía y la reducción del movimiento llegan como variables CSS y se actualizan al instante.
- Guardado seguroRanuras de guardado versionadas, con revisiones, detección de conflictos, reintentos seguros y guardado automático.
- Tiempo medidoInformas si la experiencia está en marcha. La plataforma mide el tiempo para que no tengas que contarlo.
- Momentos e insigniasPermite guardar una imagen de un momento tranquilo y solicita insignias que la plataforma verifica.
- Acciones en la cabeceraColoca el sonido, el reinicio, la ayuda y tus propias acciones sencillas en la cabecera de la plataforma.
- Idioma y horaEl contexto incluye el idioma y la zona horaria de quien visita, para que tu experiencia pueda saludarle con sus propias palabras.
Qué datos son privados
Los complementos nunca reciben una dirección de correo, un identificador de cuenta, un token ni una cookie. El contexto solo incluye un nombre visible, el idioma, la zona horaria, el nivel de membresía, el tema, la preferencia de sonido opcional y una opción aprobada de registro de la ciudad. El marco no puede abrir ventanas emergentes, mostrar cuadros de alerta, enviar formularios ni navegar por la página.
Guías
- Inicio rápidoCrea un proyecto, conéctalo a un host de prueba y guarda tu primer progreso.
- Manifiesto y permisosDeclara quién eres, dónde se encuentra tu experiencia y qué capacidades necesitas.
- Referencia del SDKTodos los métodos, opciones, límites y códigos de error del SDK cliente.
- Ciclo de vida y guardadoSaludo, pausa y reanudación, informes de actividad, revisiones y reintentos.
- Alojamiento y revisiónAloja tu experiencia, supera la revisión y publica versiones nuevas de forma segura.
Cómo obtener el SDK
@zenclub/sdk es un paquete de módulos ES sin dependencias y con tipos de TypeScript. Lo compartimos con quienes crean experiencias junto a nosotros. Escríbenos para contarnos tu idea; te enviaremos la versión actual y un turno de revisión.