Pro機能
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レート制限
認証済みユーザーは1分あたり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" }
}