API v1

API Docs

Intégrez LightSitePro dans vos outils : lancez des scans, récupérez les scores et affichez des badges dynamiques.

Authentification

Toutes les requêtes nécessitent un header X-API-Key. La clé est disponible à partir du plan Pro, dans Paramètres → Clé API.

Base URL

http://www.lightsitepro.com/api/public-api

Démarrage rapide

Lancez votre premier scan en une commande :

bash

curl -X POST "http://www.lightsitepro.com/api/public-api" \
  -H "X-API-Key: lsp_votre_clé_api" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com"}'

javascript

const response = await fetch(
  "http://www.lightsitepro.com/api/public-api",
  {
    method: "POST",
    headers: {
      "X-API-Key": "lsp_votre_clé_api",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({ url: "https://example.com" }),
  }
);
const { scanId } = await response.json();

Endpoints

POST/Lancer un scan

Démarre l’analyse d’un site web et retourne immédiatement un scanId.

Corps de la requête

json

{
  "url": "https://example.com"
}

Réponse

json

{
  "scanId": "uuid-...",
  "status": "running"
}

GET/?path=scansLister les scans

Récupère la liste de vos scans récents avec pagination.

Réponse

json

{
  "data": [
    {
      "id": "uuid-...",
      "domain": "example.com",
      "status": "completed",
      "score_global": 87
    }
  ],
  "total": 42
}

GET/scans/{id}Détails d’un scan

Récupère tous les scores, recommandations et métadonnées d’un scan.

Réponse

json

{
  "id": "uuid-...",
  "domain": "example.com",
  "status": "completed",
  "score_global": 87,
  "score_performance": 92,
  "score_seo": 85,
  "score_accessibility": 88,
  "score_security": 79,
  "score_mobile": 83
}

Badges SVG dynamiques

Affichez le score de votre site en temps réel dans vos READMEs et pages web. Les badges se mettent à jour automatiquement à chaque nouveau scan public.

Format URL

text

http://www.lightsitepro.com/api/badge/{domain}           → score global
http://www.lightsitepro.com/api/badge/{domain}/performance → score performance
http://www.lightsitepro.com/api/badge/{domain}/seo         → score SEO
http://www.lightsitepro.com/api/badge/{domain}/security    → score sécurité

Markdown (README)

markdown

![LightSite Score](http://www.lightsitepro.com/api/badge/example.com)
![Performance](http://www.lightsitepro.com/api/badge/example.com/performance)
![SEO](http://www.lightsitepro.com/api/badge/example.com/seo)

Les badges fonctionnent sur les scans marqués comme publics (is_public: true).

Rate limits

Plan Pro

60 req/min

Plan Agency

300 req/min

Les erreurs 429 incluent un header Retry-After indiquant le délai avant de réessayer.