Tính năng Agency

Tài liệu API

Tích hợp Broken Link Scan vào quy trình của bạn. Quét website, lấy kết quả và tự động hóa giám sát — tất cả qua một REST API đơn giản.

URL gốc

https://brokenlinkscan.com/api/v1

Xác thực

Mọi request API đều cần một khóa API gửi qua header X-Api-Key. Bạn có thể tạo khóa API từ bảng điều khiển.

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

Giới hạn tần suất

Người dùng đã xác thực được phép 300 request mỗi phút. Nếu vượt quá giới hạn này, API trả về phản hồi 429 Too Many Requests.

Điểm cuối

GET /api/v1/sites

Liệt kê mọi website đang được giám sát của người dùng đã xác thực.

POST /api/v1/sites

Thêm một website mới để giám sát.

Nội dung request

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

DELETE /api/v1/sites/:id

Xóa một website đang giám sát theo ID.

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

Kích hoạt một lượt quét theo yêu cầu cho một website.

GET /api/v1/scans

Liệt kê mọi lượt quét.

Tham số truy vấn

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

GET /api/v1/scans/:token

Lấy trạng thái của một lượt quét cụ thể.

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

Lấy kết quả quét chi tiết.

Tham số truy vấn

status, category, search, page, limit

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

Xuất kết quả quét dạng JSON.

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

Xuất kết quả quét dạng CSV.

POST /api/v1/scans/bulk

Kiểm tra hàng loạt một danh sách URL trong một request duy nhất.

Nội dung request

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

Định dạng phản hồi

Mọi phản hồi đều là JSON. Request thành công trả về dữ liệu trực tiếp. Lỗi kèm theo một trường message.

Thành công (200)

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

Lỗi (4xx/5xx)

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

Cần truy cập API?

REST API có trong gói Agency. Nâng cấp ngay hôm nay và bắt đầu tự động hóa việc giám sát liên kết hỏng.

Nâng cấp lên Agency