Documentazione API
Integra Broken Link Scan nel tuo flusso di lavoro. Scansiona siti, recupera risultati e automatizza il monitoraggio — tutto tramite una semplice REST API.
URL di base
https://brokenlinkscan.com/api/v1 Autenticazione
Tutte le richieste API richiedono una chiave API inviata tramite l'header X-Api-Key. Puoi generare la tua chiave API dalla dashboard.
curl -H "X-Api-Key: your_key" \
https://brokenlinkscan.com/api/v1/sitesLimite di frequenza
Gli utenti autenticati possono effettuare 300 richieste al minuto. Se superi questo limite, l'API restituisce una risposta 429 Too Many Requests.
Endpoint
/api/v1/sites Elenca tutti i siti monitorati per l'utente autenticato.
/api/v1/sites Aggiungi un nuovo sito da monitorare.
{ "url": "https://example.com", "name": "My Site" } /api/v1/sites/:id Rimuovi un sito monitorato tramite ID.
/api/v1/sites/:id/scan Avvia una scansione su richiesta per un sito.
/api/v1/scans Elenca tutte le scansioni.
page (int), limit (int, default 20)
/api/v1/scans/:token Ottieni lo stato di una scansione specifica.
/api/v1/scans/:token/results Ottieni i risultati dettagliati della scansione.
status, category, search, page, limit
/api/v1/scans/:token/export.json Esporta i risultati della scansione in JSON.
/api/v1/scans/:token/export.csv Esporta i risultati della scansione in CSV.
/api/v1/scans/bulk Verifica un elenco di URL in blocco con una singola richiesta.
{ "urls": ["https://a.com", "https://b.com"] } Formato di risposta
Tutte le risposte sono in JSON. Le richieste riuscite restituiscono direttamente i dati. Gli errori includono un campo message.
{
"data": [...],
"meta": { "page": 1, "limit": 20, "total": 42 }
}{
"error": { "code": 401, "message": "Invalid API key" }
}Hai bisogno dell'accesso API?
L'API REST è disponibile nel piano Pro. Aggiorna oggi e inizia ad automatizzare il monitoraggio dei link rotti.
Aggiorna a Pro