Aller au contenu principal

Clés API de site

Open in QuickMonitoring→ Sites → [Votre site] → Paramètres → Clés API

Les clés API de site limitent l'accès à un seul site — elles sont plus sûres à partager avec des équipes externes ou des systèmes automatisés qui n'ont besoin d'accéder qu'aux données d'un seul client. Elles sont également utilisées par le SDK QuickMonitoring pour l'envoi d'événements analytics, LLM et RUM.

Ce que vous verrez​

Allez dans Sites → votre site → Paramètres (barre latérale) → section Clés API.

Vous trouverez :

  • La liste des clés API du site — chaque clé avec son nom, ses 4 derniers caractères, sa date de création
  • Le bouton Créer une clé — pour générer une nouvelle clé API liée uniquement à ce site
  • Le bouton Révoquer — pour invalider une clé existante

Comment l'utiliser​

Créer une clé API de site​

  1. Allez dans Sites → votre site → Paramètres
  2. Faites défiler jusqu'à la section Clés API
  3. Cliquez sur Créer une clé API
  4. Donnez un nom descriptif à la clé (ex. : SDK production, CI/CD scan, Rapport client)
  5. Cliquez sur Créer
  6. Copiez immédiatement la clé — elle n'est affichée qu'une seule fois. Stockez-la dans votre gestionnaire de secrets
  7. La clé apparaît dans la liste avec ses 4 derniers caractères pour identification

Utiliser la clé API de site avec le SDK​

La clé API de site est celle que vous passez lors de l'initialisation du SDK QuickMonitoring dans votre application :

import { QuickMonitoring } from '@quickmonitoring/sdk';

const qm = new QuickMonitoring({
  siteKey: 'qm_site_votre_clé_de_site',
});

Utiliser la clé API de site pour les appels REST directs​

# Récupérer les scans d'un site spécifique
curl -H "Authorization: Bearer qm_site_votre_clé_de_site" \
  https://api.quickmonitoring.com/api/v1/sites/{site_id}/scans

# Déclencher un scan sur ce site
curl -X POST \
  -H "Authorization: Bearer qm_site_votre_clé_de_site" \
  -H "Content-Type: application/json" \
  https://api.quickmonitoring.com/api/v1/sites/{site_id}/scans

Une clé API de site ne peut accéder qu'aux ressources de ce site spécifique. Toute tentative d'accès à un autre site avec cette clé retournera une erreur 403.

Révoquer une clé API de site​

  1. Allez dans Sites → votre site → Paramètres → section Clés API
  2. Cliquez sur Révoquer à côté de la clé concernée
  3. Confirmez la révocation
  4. Mettez à jour immédiatement toutes les applications ou scripts utilisant cette clé

Différence entre clé API d'organisation et clé API de site​

CritèreClé API d'organisationClé API de site
PortéeTous les sites de l'organisationUn seul site
UsageIntégrations CI/CD générales, scripts d'administrationSDK, intégrations site-spécifiques, partage avec clients
Sécurité en cas de fuiteAccès à toute l'organisationAccès limité à un seul site
Qui peut créerOWNER et ADMIN uniquementDEVELOPER, ADMIN et OWNER

Condition de réussite​

✅ Vous avez obtenu ce badge lorsqu'au moins une clé API de site a été créée pour un de vos sites.

Problèmes fréquents​

  • J'ai perdu ma clé API de site — Même comportement que les clés d'organisation : la clé complète n'est affichée qu'une seule fois. Révoquez la clé perdue et créez-en une nouvelle. Mettez à jour le SDK ou les scripts qui l'utilisaient.

  • Le SDK dit que la clé est invalide — Vérifiez que vous utilisez une clé API de site (préfixe qm_site_) et non une clé d'organisation. Vérifiez également que la clé n'a pas été révoquée. Assurez-vous de ne pas inclure d'espaces ou de guillemets dans la valeur de la clé.

  • La clé retourne 403 sur certains endpoints — Une clé API de site ne peut accéder qu'aux données de ce site. Si vous tentez de lister tous les sites de l'organisation ou d'accéder à un autre site, la requête sera rejetée. Utilisez une clé d'organisation pour les accès multi-sites.