API REST v1

Documentation API

Intégrez les audits RefAudit dans vos outils CI/CD, scripts ou dashboards via notre API REST.

Authentification

Toutes les requêtes doivent inclure un token Bearer dans le header Authorization.

Authorization: Bearer <votre_token>

Générez vos tokens depuis votre tableau de bord.

URL de base

https://refaudit.fr/api/v1

Limites par plan

Plan	Requêtes / jour	Headers retournés
Solo	100	X-RateLimit-Limit, X-RateLimit-Remaining
Pro	500	X-RateLimit-Limit, X-RateLimit-Remaining
Agency	2 000	X-RateLimit-Limit, X-RateLimit-Remaining

Endpoints

GET /audits — Lister les audits légers

Retourne la liste paginée de vos audits légers.

Réponse

{
  "data": [
    {
      "id": 42,
      "url": "https://example.com",
      "status": "completed",
      "score": 78.5,
      "created_at": "2026-05-01T10:00:00+00:00"
    }
  ],
  "meta": { "current_page": 1, "last_page": 3, "total": 52 }
}

POST /audits — Lancer un audit léger

Crée et lance un audit léger en arrière-plan. Retourne immédiatement avec status "pending".

Body

{ "url": "https://mon-site.fr" }

Réponse

{
  "data": {
    "id": 43,
    "url": "https://mon-site.fr",
    "status": "pending",
    "score": null,
    "created_at": "2026-05-03T09:30:00+00:00"
  }
}

GET /audits/{id} — Détail d'un audit léger

Récupère un audit par son identifiant.

Réponse

{
  "data": {
    "id": 43,
    "url": "https://mon-site.fr",
    "status": "completed",
    "score": 82.0,
    "created_at": "2026-05-03T09:30:00+00:00"
  }
}

GET /full-audits — Lister les audits complets

Retourne la liste paginée de vos audits complets.

Réponse

{
  "data": [
    {
      "token": "AbC...XyZ",
      "url": "https://example.com",
      "status": "completed",
      "score": 73.5,
      "pages_crawled": 8,
      "report_url": "https://refaudit.fr/audit/full/AbC...XyZ",
      "created_at": "2026-05-01T10:00:00+00:00"
    }
  ],
  "meta": { "current_page": 1, "last_page": 1, "total": 3 }
}

GET /full-audits/{token} — Détail d'un audit complet

Récupère un audit complet par son token de rapport. Inclut jusqu'à 50 findings.

Réponse

{
  "data": {
    "token": "AbC...XyZ",
    "url": "https://example.com",
    "status": "completed",
    "score": 73.5,
    "pages_crawled": 8,
    "report_url": "https://refaudit.fr/audit/full/AbC...XyZ",
    "findings_count": 24,
    "findings": [ ... ],
    "created_at": "2026-05-01T10:00:00+00:00"
  }
}

Exemple curl

curl -X POST https://refaudit.fr/api/v1/audits \
  -H "Authorization: Bearer <votre_token>" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"url": "https://mon-site.fr"}'

Codes d'erreur

Code HTTP	Signification
401	Token manquant ou invalide
403	Accès refusé (ressource d'un autre utilisateur)
422	Validation échouée (URL invalide...)
429	Limite journalière atteinte
500	Erreur serveur