Documentation BugsPointer

Installer et personnaliser le widget BugsPointer.

Une clé publique, deux modes d’affichage et une personnalisation centralisée depuis votre dashboard. Le site client ne maintient aucun fichier BugsPointer.

Principe

Le site client ajoute le script, puis choisit son déclencheur

BugsPointer charge la modal, récupère la configuration du projet et envoie les rapports vers votre dashboard. Le déclencheur peut être un bouton flottant ou un lien placé dans votre site.

Voir mon script

Étape 1

Installation

Option 1 : bouton flottant

Copiez cette balise pour afficher automatiquement le bouton BugsPointer sur votre site. Elle contient votre clé publique et charge le widget depuis BugsPointer.

Utilisez cette option si vous voulez ouvrir la modal depuis un lien dans le footer, le menu, une page d’aide ou un bloc personnalisé. Le script charge la modal, mais n’affiche pas de bouton flottant.

Laissez le lien vide si vous souhaitez utiliser le texte enregistré dans la personnalisation du widget. Vous pouvez aussi écrire votre propre texte entre les balises <a>.

Clé publique

data-public-key relie le widget a votre compte BugsPointer. Cette clé est publique : elle peut apparaître dans le HTML du site client.

Format obligatoire : pk_xxxxx.

Où placer le script

Placez le script sur les pages où les utilisateurs peuvent signaler un bug. Le plus simple est de le coller avant la fermeture du </body>.

L’attribut defer laisse la page se charger correctement avant l’exécution du widget.

Si vous utilisez un lien personnalisé, placez aussi la balise <a data-bugspointer-open> à l’endroit exact où le lien doit apparaître.

Tips : Le plus simple est de placer le script dans un fichier présent dans toutes les pages

Étape 2

Plateformes compatibles

WordPress, Joomla, Drupal, Webflow, Shopify

Ajoutez le script dans la zone de code personnalisé, le footer du thème, un module HTML ou un plugin d’injection de scripts.

Sur certaines plateformes SaaS, l’ajout de JavaScript externe dépend du plan du client.

React, Angular, Vue, Next.js, sites from scratch

Ajoutez le script dans le layout global, le template HTML principal, ou injectez-le au montage de l’application.

Pour une SPA, le widget reste disponible pendant la navigation et récupère l’URL courante au moment de l’ouverture de la modal.

Étape 3

Personnalisation

Depuis le dashboard

Depuis la page Widget, vous pouvez modifier :

  • la couleur principale du bouton et des actions
  • la couleur de fond, du texte et du titre de la modal
  • la couleur du lien placé dans le site
  • le soulignement du lien
  • le texte du lien
  • le titre de la modal
  • le libellé du champ description
  • la taille, la position et les marges du bouton flottant

Le choix “bouton” ou “lien” dans la page Widget sert à prévisualiser les bons réglages. Il ne bloque pas l’autre déclencheur : si le code du bouton et le code du lien sont installés sur le site, les deux peuvent fonctionner.

À vérifier

Points techniques

CORS

Le chargement de la balise <script> n’est pas bloqué par CORS. En revanche, le widget appelle l’API BugsPointer pour récupérer la configuration et envoyer les rapports.

BugsPointer doit donc autoriser les routes publiques GET /api/widget/config et POST /api/user/modalControl.

Content Security Policy

Si le site client utilise une CSP stricte, il doit autoriser BugsPointer :

Sans cela, le navigateur peut bloquer le script ou les appels API.

Sécurité

La clé pk_xxxxx est publique. Elle identifie le projet, mais ne donne aucun accès privé.

Pour limiter les abus, le domaine du site doit être renseigné dans le compte BugsPointer et comparé à l’URL du rapport.

Utilisation

Signaler et gérer les bugs

Signaler un bug

L’utilisateur clique sur le bouton ou le lien BugsPointer, pointe l’élément concerné sur la page, décrit le problème puis envoie le rapport.

Le rapport inclut l’URL, l’élément pointé, la description, le navigateur, l’OS, la langue du navigateur, le type d’appareil et la taille du viewport.

Gérer les rapports

Les rapports arrivent dans le dashboard. Vous pouvez ensuite les classer en nouveau, en cours, résolu ou ignoré.

Selon vos préférences de notification, vous pouvez recevoir un e-mail à la réception d’un nouveau bug.