Agency-functie

API-documentatie

Integreer Broken Link Scan in je workflow. Scan sites, haal resultaten op en automatiseer monitoring — allemaal via een eenvoudige REST API.

Basis-URL

https://brokenlinkscan.com/api/v1

Authenticatie

Alle API-verzoeken vereisen een API-sleutel verzonden via de X-Api-Key header. Je kunt je API-sleutel genereren vanuit het dashboard.

curl -H "X-Api-Key: your_key" \
     https://brokenlinkscan.com/api/v1/sites

Snelheidsbeperking

Geauthenticeerde gebruikers mogen 300 verzoeken per minuut uitvoeren. Als je deze limiet overschrijdt, retourneert de API een 429 Too Many Requests antwoord.

Endpoints

GET /api/v1/sites

Lijst alle gemonitorde sites voor de geauthenticeerde gebruiker.

POST /api/v1/sites

Voeg een nieuwe site toe om te monitoren.

Verzoekinhoud

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

DELETE /api/v1/sites/:id

Verwijder een gemonitorde site op basis van ID.

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

Start een scan op aanvraag voor een site.

GET /api/v1/scans

Lijst alle scans.

Queryparameters

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

GET /api/v1/scans/:token

Bekijk de status van een specifieke scan.

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

Bekijk gedetailleerde scanresultaten.

Queryparameters

status, category, search, page, limit

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

Exporteer scanresultaten als JSON.

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

Exporteer scanresultaten als CSV.

POST /api/v1/scans/bulk

Controleer een lijst URL's in bulk in één verzoek.

Verzoekinhoud

{ "urls": ["https://a.com", "https://b.com"] }

Antwoordformaat

Alle antwoorden zijn in JSON. Succesvolle verzoeken retourneren de gegevens direct. Fouten bevatten een message-veld.

Succes (200)

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

Fout (4xx/5xx)

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

API-toegang nodig?

De REST API is beschikbaar in het Agency-plan. Upgrade vandaag nog en begin met het automatiseren van je broken link monitoring.

Upgraden naar Agency