@vox-pulse/sdk

Client JavaScript de Vox Pulse — navigateur, sans dépendance de framework.

npm install @vox-pulse/sdk

Récupérez votre clé publique dans Vox Pulse → Dashboard → Paramètres (elle commence par vpk_). Cette clé est conçue pour vivre dans le navigateur : elle n'autorise que l'envoi de retours, jamais la lecture.

Utilisation

import { VoxPulse } from "@vox-pulse/sdk";

VoxPulse.init({
  apiKey: "vpk_...",
  apiBase: "https://votre-instance-vox-pulse",
  user: { email: "[email protected]", plan: "pro", mrr: 4900 },
});

VoxPulse.loadWidget();                    // widget flottant
VoxPulse.track("export_lancé");           // évènement
VoxPulse.sendFeedback({ type: "bug", title: "L'export échoue" });

Appelez identify() après la connexion pour rattacher les retours à un utilisateur :

VoxPulse.identify({ email, name, plan, mrr });

apiBase

Passez toujours l'URL de votre instance Vox Pulse :

apiBase: "https://votre-instance-vox-pulse"

Sans elle, le SDK ne sait pas où envoyer les retours.

Ce qui est transmis

À chaque retour : le titre et la description saisis, l'URL de la page (sans query string ni fragment), le navigateur, l'OS, la taille de la fenêtre, et le contexte utilisateur que vous avez fourni via identify().

Aucun cookie de votre application n'est transmis : les requêtes partent en credentials: "omit".

Licence

MIT