Référence API

API Scanner Serge

L'API expose le scanner déterministe de Serge pour des scans programmatiques et la récupération de rapports. Elle ne couvre que le scan ; la visibilité des sessions, le replay et le briefing vivent dans le produit principal. L'accès anonyme commence à 5 scans/h, ou authentifiez-vous avec une clé secrète pour 60 scans/h.

Spécification OpenAPI llms.txt Docs complets (llms-full.txt)Démarrage rapide MCP Méthodologie

Également disponible

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 MCP

URL de base

Authentification

L'API scanner fonctionne sans authentification à 5 scans/h. Pour des limites supérieures, 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	5 scans/h par IP	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

POST/api/scan

Initie 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.

Corps de la requête

Événements SSE

statusMise à jour de phase de scan — inclut la description de la phase actuelle

crawlProgression du crawl — inclut l'URL crawlée et le statut

layerScan de layer terminé — inclut le numéro du layer, le score et les résultats des vérifications

completeScan terminé — inclut l'ID du scan, le score global et la répartition par layer

errorÉchec du scan — inclut le message d'erreur

Exemple (anonyme)

Exemple (authentifié — 60 scans/h)

GET/api/scan/{id}

Récupère les résultats complets pour un scan terminé. Les réponses sont mises en cache pendant 1 heure.

Paramètres de chemin

idUUID du scan (renvoyé par l'événement SSE complete)

Réponse

Réponses d'erreur

400Format d'ID de scan invalide

404Scan introuvable

Exemple

É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.

score.changed

Ressources lisibles par machine

/openapi.jsonSpécification OpenAPI 3.1

/llms.txtDescription produit pour LLM

/llms-full.txtDocumentation étendue pour LLM

/.well-known/agent.jsonCarte d'agent A2A avec capacités

/methodologyMéthodologie de notation (en cours de refonte)

/sitemap.xmlSitemap XML

/robots.txtPermissions de crawler