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 प्रतिक्रिया लौटाता है।
एंडपॉइंट्स
/api/v1/sites प्रमाणित उपयोगकर्ता की सभी मॉनिटर की गई साइट्स सूचीबद्ध करें।
/api/v1/sites मॉनिटर करने के लिए एक नई साइट जोड़ें।
{ "url": "https://example.com", "name": "My Site" } /api/v1/sites/:id ID द्वारा मॉनिटर की गई साइट हटाएँ।
/api/v1/sites/:id/scan एक साइट के लिए ऑन-डिमांड स्कैन ट्रिगर करें।
/api/v1/scans सभी स्कैन सूचीबद्ध करें।
page (int), limit (int, default 20)
/api/v1/scans/:token एक विशिष्ट स्कैन की स्थिति प्राप्त करें।
/api/v1/scans/:token/results विस्तृत स्कैन परिणाम प्राप्त करें।
status, category, search, page, limit
/api/v1/scans/:token/export.json स्कैन परिणामों को JSON के रूप में निर्यात करें।
/api/v1/scans/:token/export.csv स्कैन परिणामों को CSV के रूप में निर्यात करें।
/api/v1/scans/bulk एक ही अनुरोध में URL की सूची को बल्क-चेक करें।
{ "urls": ["https://a.com", "https://b.com"] } प्रतिक्रिया प्रारूप
सभी प्रतिक्रियाएँ JSON में हैं। सफल अनुरोध सीधे डेटा लौटाते हैं। त्रुटियों में एक message फ़ील्ड शामिल होता है।
{
"data": [...],
"meta": { "page": 1, "limit": 20, "total": 42 }
}{
"error": { "code": 401, "message": "Invalid API key" }
}API एक्सेस चाहिए?
REST API एजेंसी प्लान में उपलब्ध है। आज ही अपग्रेड करें और अपनी टूटे लिंक मॉनिटरिंग को स्वचालित करना शुरू करें।
एजेंसी में अपग्रेड करें