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

Action	Crédits
Audit complet (deep)	20 crédits
Audit rapide (fast)	10 crédits
Régénération email	10 crédits
Génération lead email	10 crédits

Quotas par plan

Plan	Crédits	Audits deep (~)
Gratuit	20	1 audit offert
Starter	200	10 audits
Pro	2 400	120 audits
Business	10 000	500 audits

Les crédits permettent aussi la régénération d'emails (10 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.

Obtenez votre clé API

Rendez-vous dans Paramètres → API pour générer ou copier votre clé.

Lancez votre première requête

bash

# 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"

Lisez le rapport

Interrogez GET /audit/{auditId} jusqu'à obtenir status: "completed". Le champ reportUrl contient le lien vers le rapport complet.

Authentification

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

http

Authorization: Bearer ra_live_xxxxxxxxxxxxxxxxxxxxx

Traitez votre clé comme un mot de passe — ne la committez jamais dans git et ne l'exposez pas côté client. Utilisez des variables d'environnement.

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

POST

/v1/audit

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

Paramètres du body

Nom	Type	Statut	Description
`url`	`string`	Requis	URL complète du site à auditer (ex: https://example.com)
`mode`	`'fast' \| 'deep'`	Optionnel	Mode d'audit. Défaut : deep (30+ sources, email enrichi)

Request

json

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

Response 200

json

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

GET

/v1/audit/{auditId}

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

pendingprocessingcompletedfailed

json

{
  "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": 20,
  "createdAt": "2026-03-22T10:00:00Z",
  "completedAt": "2026-03-22T10:01:32Z"
}

GET

/v1/credits

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

Request

bash

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

Response 200

json

{
  "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

json

{
  "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"
}

Vérifiez la signature HMAC-SHA256 incluse dans l'en-tête X-Residual-Signature pour valider l'authenticité de chaque payload.

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.

📓

Notion

Envoyez les rapports dans une base de données Notion.

💬

Slack

Recevez des alertes dans vos canaux Slack.

🟦

Teams

Notifications dans Microsoft Teams.

🎮

Discord

Alertes dans vos serveurs Discord.