API Scanner Serge
L'API expose le scanner déterministe de Serge pour les scans programmatiques et la récupération de rapports. Elle ne couvre que le scan ; le produit complet Agent Journey Test vit dans l'app principale. Le scan exige une authentification — passez une clé secrète pour 60 scans/h par workspace. La lecture des rapports en cache reste publique.
Vous cherchez le paquet local Claude Desktop plutôt que l'API scanner hébergée ? Le paquet Serge MCP est de retour dans les docs, y compris le démarrage rapide hors ligne.
→ Ouvrir le démarrage rapide Serge MCPURL de base
Authentification
Le lancement de scans exige une authentification — les requêtes anonymes reçoivent 401. Passez une clé secrète via l'en-tête Authorization :
Créez des clés secrètes dans vos paramètres de compte. Les clés utilisent le préfixe sk_serge_. Traitez-les comme des mots de passe.
Limites de débit
Toutes les réponses API incluent des en-têtes de limite de débit :
| En-tête | Description |
|---|---|
X-RateLimit-Limit | Requêtes maximales par fenêtre |
X-RateLimit-Remaining | Requêtes restantes |
X-RateLimit-Reset | Horodatage Unix de réinitialisation de la fenêtre |
Retry-After | Secondes jusqu'à la réinitialisation (réponses 429 uniquement) |
| Tier | Limite de débit | Auth |
|---|---|---|
| Anonyme | Indisponible — renvoie 401 | Aucune |
| Authentifié | 60 scans/h par workspace | Authorization: Bearer sk_serge_... |
Limite de débit par domaine : 5 scans par heure par domaine cible (partagés entre tiers).
Endpoints
/api/scanInitie un scan de domaine. Renvoie un flux Server-Sent Events avec progression en temps réel pendant que le scan crawle le site et émet des constatations.
statusMise à jour de phase de scan — inclut la description de la phase actuellecrawlProgression du crawl — inclut l'URL crawlée et le statutlayerScan de layer terminé — inclut le numéro du layer, le score et les résultats des vérificationscompleteScan terminé — inclut l'ID du scan, le score global et la répartition par layererrorÉchec du scan — inclut le message d'erreur/api/scan/{id}Récupère les résultats complets pour un scan terminé. Les réponses sont mises en cache pendant 1 heure.
idUUID du scan (renvoyé par l'événement SSE complete)400Format d'ID de scan invalide404Scan introuvableÉvénements webhook
Serge peut vous notifier quand le score d'un domaine surveillé change. Abonnez-vous aux notifications de changement de score via le formulaire e-mail sur n'importe quelle page de résultats de scan.