에이전시 기능
API 문서
Broken Link Scan을 워크플로에 통합하세요. 간단한 REST API를 통해 사이트를 스캔하고, 결과를 검색하고, 모니터링을 자동화하세요.
기본 URL
https://brokenlinkscan.com/api/v1 인증
모든 API 요청은 X-Api-Key 헤더를 통해 전송된 API 키가 필요합니다. 대시보드에서 API 키를 생성할 수 있습니다.
curl -H "X-Api-Key: your_key" \
https://brokenlinkscan.com/api/v1/sites요청 제한
인증된 사용자는 분당 300회 요청이 허용됩니다. 이 제한을 초과하면 API가 429 Too Many Requests 응답을 반환합니다.
엔드포인트
GET
/api/v1/sites 인증된 사용자의 모든 모니터링 사이트를 나열합니다.
POST
/api/v1/sites 모니터링할 새 사이트를 추가합니다.
요청 본문
{ "url": "https://example.com", "name": "My Site" } DELETE
/api/v1/sites/:id ID로 모니터링 사이트를 제거합니다.
POST
/api/v1/sites/:id/scan 사이트에 대한 온디맨드 스캔을 시작합니다.
GET
/api/v1/scans 모든 스캔을 나열합니다.
쿼리 파라미터
page (int), limit (int, default 20)
GET
/api/v1/scans/:token 특정 스캔의 상태를 가져옵니다.
GET
/api/v1/scans/:token/results 상세 스캔 결과를 가져옵니다.
쿼리 파라미터
status, category, search, page, limit
GET
/api/v1/scans/:token/export.json 스캔 결과를 JSON으로 내보냅니다.
GET
/api/v1/scans/:token/export.csv 스캔 결과를 CSV로 내보냅니다.
POST
/api/v1/scans/bulk 단일 요청으로 URL 목록을 대량 검사합니다.
요청 본문
{ "urls": ["https://a.com", "https://b.com"] } 응답 형식
모든 응답은 JSON입니다. 성공한 요청은 데이터를 직접 반환합니다. 오류에는 message 필드가 포함됩니다.
성공 (200)
{
"data": [...],
"meta": { "page": 1, "limit": 20, "total": 42 }
} 오류 (4xx/5xx)
{
"error": { "code": 401, "message": "Invalid API key" }
}