Documentation API
Intégrez Broken Link Scan dans votre workflow. Scannez des sites, récupérez les résultats et automatisez la surveillance — le tout via une API REST simple.
URL de base
https://brokenlinkscan.com/api/v1 Authentification
Toutes les requêtes API nécessitent une clé API envoyée via l'en-tête X-Api-Key. Vous pouvez générer votre clé API depuis le tableau de bord.
curl -H "X-Api-Key: your_key" \
https://brokenlinkscan.com/api/v1/sitesLimitation de débit
Les utilisateurs authentifiés sont autorisés à effectuer 300 requêtes par minute. Si vous dépassez cette limite, l'API renvoie une réponse 429 Too Many Requests.
Points d'accès
/api/v1/sites Lister tous les sites surveillés pour l'utilisateur authentifié.
/api/v1/sites Ajouter un nouveau site à surveiller.
{ "url": "https://example.com", "name": "My Site" } /api/v1/sites/:id Supprimer un site surveillé par son ID.
/api/v1/sites/:id/scan Déclencher un scan à la demande pour un site.
/api/v1/scans Lister tous les scans.
page (int), limit (int, default 20)
/api/v1/scans/:token Obtenir le statut d'un scan spécifique.
/api/v1/scans/:token/results Obtenir les résultats détaillés d'un scan.
status, category, search, page, limit
/api/v1/scans/:token/export.json Exporter les résultats d'un scan en JSON.
/api/v1/scans/:token/export.csv Exporter les résultats d'un scan en CSV.
/api/v1/scans/bulk Vérifier en masse une liste d'URL en une seule requête.
{ "urls": ["https://a.com", "https://b.com"] } Format de réponse
Toutes les réponses sont en JSON. Les requêtes réussies renvoient les données directement. Les erreurs incluent un champ message.
{
"data": [...],
"meta": { "page": 1, "limit": 20, "total": 42 }
}{
"error": { "code": 401, "message": "Invalid API key" }
}Besoin d'un accès API ?
L'API REST est disponible avec le plan Pro. Passez au supérieur dès aujourd'hui et commencez à automatiser la surveillance de vos liens cassés.
Passer au plan Pro