Aller au contenu principal

Clés API d'organisation

Open in QuickMonitoring→ Organisation → Paramètres → Clés API

Les clés API d'organisation donnent un accès programmatique à l'API QuickMonitoring pour l'ensemble de votre organisation — utilisez-les pour déclencher des scans, récupérer des résultats, ou intégrer QuickMonitoring dans vos pipelines CI/CD. Seuls les OWNER et ADMIN peuvent créer et gérer les clés API d'organisation.

Ce que vous verrez​

Allez dans le menu utilisateur en haut à droite → Paramètres de l'organisation → onglet Clés API.

Vous trouverez :

  • La liste des clés API actives — chaque clé avec son nom, ses 4 derniers caractères (la clé complète n'est jamais réaffichée), sa date de création et son créateur
  • Le bouton Créer une clé — pour générer une nouvelle clé API d'organisation
  • Le bouton Révoquer — pour invalider immédiatement une clé existante

Comment l'utiliser​

Créer une clé API d'organisation​

  1. Allez dans Paramètres de l'organisation → onglet Clés API
  2. Cliquez sur Créer une clé API
  3. Donnez un nom descriptif à la clé (ex. : CI/CD GitHub Actions, Intégration Slack, Script de rapport mensuel)
  4. Cliquez sur Créer
  5. Copiez immédiatement la clé affichée — elle ne sera plus jamais affichée en clair après fermeture de ce dialogue. Stockez-la dans votre gestionnaire de secrets (ex. : GitHub Secrets, HashiCorp Vault, AWS Secrets Manager)
  6. La clé apparaît dans la liste avec ses 4 derniers caractères pour identification

Utiliser la clé API dans vos requêtes​

Incluez la clé dans l'en-tête Authorization de chaque requête HTTP :

curl -H "Authorization: Bearer qm_org_votre_clé_api" \
  https://api.quickmonitoring.com/api/v1/sites

Exemple : déclencher un scan via CI/CD​

# .github/workflows/scan-after-deploy.yml
- name: Trigger QuickMonitoring scan
  run: |
    curl -X POST \
      -H "Authorization: Bearer ${{ secrets.QM_API_KEY }}" \
      -H "Content-Type: application/json" \
      https://api.quickmonitoring.com/api/v1/sites/${{ vars.SITE_ID }}/scans

Révoquer une clé API​

  1. Allez dans Paramètres de l'organisation → onglet Clés API
  2. Localisez la clé à révoquer (identifiable par son nom ou ses 4 derniers caractères)
  3. Cliquez sur Révoquer
  4. Confirmez la révocation — toutes les requêtes utilisant cette clé retourneront immédiatement une erreur 401

Bonnes pratiques de sécurité​

  • Ne stockez jamais une clé API dans votre code source ou dans un dépôt Git
  • Utilisez des noms descriptifs pour chaque clé afin d'identifier facilement son usage
  • Créez une clé distincte par système ou pipeline — cela permet de révoquer un accès spécifique sans perturber les autres intégrations
  • Faites tourner vos clés régulièrement (créez une nouvelle clé, mettez à jour vos systèmes, révoquez l'ancienne)
  • Surveillez les journaux d'accès API pour détecter toute utilisation anormale

Condition de réussite​

✅ Vous avez obtenu ce badge lorsqu'au moins une clé API d'organisation a été créée (active ou révoquée).

Problèmes fréquents​

  • J'ai perdu ma clé API — La clé complète n'est affichée qu'une seule fois lors de la création. Si vous l'avez perdue, révoquez la clé existante et créez-en une nouvelle. Mettez à jour toutes les intégrations utilisant l'ancienne clé.

  • La clé retourne une erreur 401 — Vérifiez que vous envoyez bien la clé dans l'en-tête Authorization avec le préfixe Bearer . Vérifiez aussi que la clé n'a pas été révoquée dans l'interface. Assurez-vous de ne pas copier des espaces ou des retours à la ligne autour de la clé.

  • Je ne vois pas l'onglet Clés API — Cet onglet est réservé aux OWNER et ADMIN. Si vous n'avez pas accès, votre rôle dans l'organisation est DEVELOPER ou VIEWER.

  • Ma clé API d'organisation peut-elle accéder à tous les sites ? — Oui. Une clé API d'organisation a accès à toutes les ressources de l'organisation. Pour un accès limité à un seul site, utilisez une clé API de site (voir Clés API de site).