API-Dokumentation
Integrieren Sie Broken Link Scan in Ihren Workflow. Scannen Sie Websites, rufen Sie Ergebnisse ab und automatisieren Sie die Überwachung — alles über eine einfache REST API.
Basis-URL
https://brokenlinkscan.com/api/v1 Authentifizierung
Alle API-Anfragen erfordern einen API-Schlüssel, der über den X-Api-Key-Header gesendet wird. Sie können Ihren API-Schlüssel im Dashboard generieren.
curl -H "X-Api-Key: your_key" \
https://brokenlinkscan.com/api/v1/sitesRatenbegrenzung
Authentifizierte Benutzer dürfen 300 Anfragen pro Minute stellen. Bei Überschreitung dieses Limits gibt die API eine 429 Too Many Requests-Antwort zurück.
Endpunkte
/api/v1/sites Alle überwachten Websites des authentifizierten Benutzers auflisten.
/api/v1/sites Eine neue Website zur Überwachung hinzufügen.
{ "url": "https://example.com", "name": "My Site" } /api/v1/sites/:id Eine überwachte Website anhand der ID entfernen.
/api/v1/sites/:id/scan Einen On-Demand-Scan für eine Website auslösen.
/api/v1/scans Alle Scans auflisten.
page (int), limit (int, default 20)
/api/v1/scans/:token Den Status eines bestimmten Scans abrufen.
/api/v1/scans/:token/results Detaillierte Scan-Ergebnisse abrufen.
status, category, search, page, limit
/api/v1/scans/:token/export.json Scan-Ergebnisse als JSON exportieren.
/api/v1/scans/:token/export.csv Scan-Ergebnisse als CSV exportieren.
/api/v1/scans/bulk Eine Liste von URLs in einer einzigen Anfrage massenhaft prüfen.
{ "urls": ["https://a.com", "https://b.com"] } Antwortformat
Alle Antworten sind JSON. Erfolgreiche Anfragen geben die Daten direkt zurück. Fehler enthalten ein message-Feld.
{
"data": [...],
"meta": { "page": 1, "limit": 20, "total": 42 }
}{
"error": { "code": 401, "message": "Invalid API key" }
}API-Zugang benötigt?
Die REST API ist im Pro-Plan verfügbar. Upgraden Sie noch heute und automatisieren Sie Ihre Broken-Link-Überwachung.
Auf Pro upgraden