Agency-Funktion

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/sites

Ratenbegrenzung

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

GET /api/v1/sites

Alle überwachten Websites des authentifizierten Benutzers auflisten.

POST /api/v1/sites

Eine neue Website zur Überwachung hinzufügen.

Anfragekörper

{ "url": "https://example.com", "name": "My Site" }

DELETE /api/v1/sites/:id

Eine überwachte Website anhand der ID entfernen.

POST /api/v1/sites/:id/scan

Einen On-Demand-Scan für eine Website auslösen.

GET /api/v1/scans

Alle Scans auflisten.

Abfrageparameter

page (int), limit (int, default 20)

GET /api/v1/scans/:token

Den Status eines bestimmten Scans abrufen.

GET /api/v1/scans/:token/results

Detaillierte Scan-Ergebnisse abrufen.

Abfrageparameter

status, category, search, page, limit

GET /api/v1/scans/:token/export.json

Scan-Ergebnisse als JSON exportieren.

GET /api/v1/scans/:token/export.csv

Scan-Ergebnisse als CSV exportieren.

POST /api/v1/scans/bulk

Eine Liste von URLs in einer einzigen Anfrage massenhaft prüfen.

Anfragekörper

{ "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.

Erfolg (200)

{
  "data": [...],
  "meta": { "page": 1, "limit": 20, "total": 42 }
}

Fehler (4xx/5xx)

{
  "error": { "code": 401, "message": "Invalid API key" }
}

API-Zugang benötigt?

Die REST API ist im Agency-Plan verfügbar. Upgraden Sie noch heute und automatisieren Sie Ihre Broken-Link-Überwachung.

Auf Agency upgraden