XenonFlare

API pour développeurs

Site Audit API — mettre en file les crawls et lire les résultats par programmation

Mettez en file les crawls avant les mises en production. Interrogez jusqu’à complétion et récupérez les liens des rapports — sans tableau de bord.

Jobs asynchrones

Mettez en file les crawls, interrogez jusqu’à complétion, récupérez les liens des rapports

La Site Audit API utilise le même modèle de jobs asynchrones que les intégrations CI et cron — POST pour mettre en file, GET pour interroger, puis listez les rapports partagés quand le scan est terminé.

Quick start (curl)

Replace $XF_API_KEY and property IDs with values from your workspace. Full reference: Developer API docs.

curl -s -X POST \
  -H "Authorization: Bearer $XF_API_KEY" \
  -H "Idempotency-Key: scan-$(date +%s)" \
  -H "Content-Type: application/json" \
  -d @scan-body.json \
  https://api.xenonflare.com/api/v1/properties/$XF_PROPERTY_ID/scans

Créer son propre crawler vs l’API XenonFlare

Développez en interne quand…

  • Navigateurs sans interfacefiles de politesse et infrastructure de crawl
  • Règles de scoringtaxonomie des problèmes et stockage des rapports
  • Authentification de l’intégrateurlimites de débit, idempotency et interrogation des jobs
  • Supervisionlorsque les robots se heurtent à une protection anti-bot ou à des problèmes TLS

Utilisez XenonFlare quand…

  • Planifier des scans du site completavec POST /properties/:id/scans
  • Interroger le statut du jobscore et nombre d’issues via GET /jobs/:id
  • Clés Bearer « scoped »clés de test pour CI, et génération de code OpenAPI
  • Même moteur de crawlqu’une web app avec superposition GSC + API

Parcours client

“Nous suivons 40 sites clients via un seul tableau de bord interne. Des scans par lots chaque nuit, des alertes webhooks en cas d’échec d’un crawl, et des exports d’activité en CSV pour le reporting client — sans vous connecter à chaque propriété.”

Agence digitale utilisant XenonFlare Developer API sur Growth

  • 40 propriétés
  • POST /scans/batch
  • Historique de livraison des webhooks
  • Export CSV d’activité

Flux d’intégration typique

  1. Créer un espace Starter ou Growth, puis une clé API avec jobs:write
  2. Résoudre les ID des propriétés via GET /properties
  3. Mettre un scan en file avec POST /properties/:id/scans
  4. Interroger GET /jobs/:id jusqu’à ce que le statut soit terminé ou en échec

Ce que vous obtenez

Mettre en file des jobs de scan SEO pour le site complet

Suivre le statut, la progression et les résultats

Lister les liens actifs de rapports d’audit partagés

jobs:read/write, reports:read, properties:read

Idempotency-Key

Reprises sûres lors des requêtes d’écriture

Limites de débit

1 000 lectures/heure et 60 écritures/heure par clé (500 écritures d’organisation/jour)

FAQ

Les agences peuvent-elles revendre l’accès à l’API à leurs clients ?

Les agences exécutent un seul espace Growth avec les propriétés des clients à l’intérieur, en utilisant des clés « scoped » pour les tableaux de bord et les scans nocturnes. La livraison se fait via des liens partagés, des webhooks ou votre portail — les clients n’ont pas besoin de détenir des clés API.

Quel plan inclut l’API Site Audit ?

L’accès à l’API pour développeurs nécessite Starter ou Growth. Le plan Free inclut l’application web et les outils gratuits xenonflare.com, mais pas les clés API.

En quoi est-ce différent de l’outil d’audit gratuit ?

Les outils gratuits fournissent un aperçu d’une page sans compte. L’API met en file des crawls pour le site complet liés à votre espace, avec historique des jobs, limites de crawl du plan et rapports partageables.

Quelles sont les limites de débit de l’API ?

Par défaut : 1 000 requêtes de lecture par heure et par clé, 60 requêtes d’écriture par heure et par clé, et 500 requêtes d’écriture par organisation par jour. Jusqu’à 5 clés actives par espace. Consultez la documentation Developer API pour les détails.

Developer API dans les plans d’espace de travail payants

Créez des clés API dans l’application web après la mise à niveau. Le palier gratuit inclut le tableau de bord et les outils marketing gratuits — pas les clés REST.