Introduction

L'API Residual Audit vous permet de déclencher des audits de sécurité, performance et SEO sur n'importe quelle URL, et de récupérer les résultats programmatiquement. Intégrez-la dans vos outils CI/CD, plateformes no-code ou tableaux de bord internes.

La base URL de toutes les requêtes est https://audit.residual-labs.fr/api/v1. Toutes les réponses sont au format JSON.

Rate limits

Les requêtes sont limitées à 10 req/min/IP. En cas de dépassement, l'API retourne un code 429.

Coût en crédits

Quotas par plan

Les crédits permettent aussi la régénération d'emails (5 crédits) et la génération de leads via Prospect Radar (10 crédits).

Démarrage rapide

En trois étapes, lancez votre premier audit et récupérez le rapport.

# 1. Lancer un audit
curl -X POST https://audit.residual-labs.fr/api/v1/audit \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com", "mode": "deep"}'

# Réponse
# { "auditId": "abc123", "status": "pending", "creditsRemaining": 80 }

# 2. Récupérer le résultat (polling)
curl https://audit.residual-labs.fr/api/v1/audit/abc123 \
  -H "Authorization: Bearer YOUR_API_KEY"

Authentification

Toutes les requêtes doivent inclure votre clé API dans l'en-tête Authorization sous forme d'un Bearer token.

Authorization: Bearer ra_live_xxxxxxxxxxxxxxxxxxxxx

Générez ou révoquez vos clés depuis Paramètres → API.

Lance un audit sur une URL. Consomme 10 crédits en mode deep ou 3 crédits en mode fast. Retourne immédiatement un auditId à utiliser pour le polling.

Paramètres du body

{
  "url": "https://example.com",
  "mode": "deep"
}

{
  "auditId": "abc123",
  "status": "pending",
  "creditsRemaining": 80,
  "pollUrl": "/api/v1/audit/abc123"
}

Retourne l'état et le rapport complet d'un audit. Interrogez cet endpoint toutes les 5 secondes jusqu'à obtenir completed ou failed.

Valeurs de status

{
  "auditId": "abc123",
  "status": "completed",
  "domain": "example.com",
  "score": 74,
  "scoreBreakdown": {
    "security": 80,
    "performance": 68,
    "seo": 75
  },
  "findings": [
    {
      "type": "critical",
      "category": "security",
      "title": "En-têtes HTTP de sécurité manquants",
      "description": "Content-Security-Policy absent"
    }
  ],
  "reportUrl": "https://audit.residual-labs.fr/audit/abc123",
  "creditsConsumed": 10,
  "createdAt": "2026-03-22T10:00:00Z",
  "completedAt": "2026-03-22T10:01:32Z"
}

Retourne votre solde de crédits actuel, votre plan et le nombre d'audits restants.

curl https://audit.residual-labs.fr/api/v1/credits \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "credits": 180,
  "plan": "pro",
  "auditsRemaining": 9
}

Webhooks

Configurez une URL de webhook depuis Paramètres → Intégrations. Residual Audit enverra une requête POST à votre endpoint dès qu'un audit est terminé.

Payload

{
  "event": "audit.completed",
  "auditId": "abc123",
  "domain": "example.com",
  "score": 74,
  "scoreBreakdown": {
    "security": 80,
    "performance": 68,
    "seo": 75
  },
  "criticalFindings": 2,
  "reportUrl": "https://audit.residual-labs.fr/audit/abc123",
  "timestamp": "2026-03-22T10:00:00Z"
}

Intégrations

Connectez Residual Audit à vos outils préférés en quelques clics depuis Paramètres → Intégrations. Des guides détaillés sont disponibles pour chaque connecteur.

Partenariats

Vous construisez un produit autour de la cybersécurité ou de l'audit digital ? Contactez-nous pour explorer les opportunités de collaboration.

Changelog