Funkcja Agency

Dokumentacja API

Zintegruj Broken Link Scan ze swoim przepływem pracy. Skanuj strony, pobieraj wyniki i automatyzuj monitorowanie — wszystko za pomocą prostego REST API.

Bazowy URL

https://brokenlinkscan.com/api/v1

Uwierzytelnianie

Wszystkie żądania API wymagają klucza API wysyłanego w nagłówku X-Api-Key. Klucz API możesz wygenerować w panelu.

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

Ograniczenie szybkości

Uwierzytelnieni użytkownicy mają dozwolone 300 żądań na minutę. Po przekroczeniu tego limitu API zwraca odpowiedź 429 Too Many Requests.

Punkty końcowe

GET /api/v1/sites

Wyświetl wszystkie monitorowane strony dla uwierzytelnionego użytkownika.

POST /api/v1/sites

Dodaj nową stronę do monitorowania.

Treść żądania

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

DELETE /api/v1/sites/:id

Usuń monitorowaną stronę po ID.

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

Uruchom skanowanie na żądanie dla strony.

GET /api/v1/scans

Wyświetl wszystkie skany.

Parametry zapytania

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

GET /api/v1/scans/:token

Pobierz status konkretnego skanu.

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

Pobierz szczegółowe wyniki skanu.

Parametry zapytania

status, category, search, page, limit

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

Eksportuj wyniki skanu jako JSON.

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

Eksportuj wyniki skanu jako CSV.

POST /api/v1/scans/bulk

Zbiorowo sprawdź listę URL w jednym żądaniu.

Treść żądania

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

Format odpowiedzi

Wszystkie odpowiedzi są w formacie JSON. Udane żądania zwracają dane bezpośrednio. Błędy zawierają pole message.

Sukces (200)

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

Błąd (4xx/5xx)

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

Potrzebujesz dostępu do API?

REST API jest dostępne w planie Agency. Uaktualnij już dziś i zacznij automatyzować monitorowanie uszkodzonych linków.

Uaktualnij do Agency