توثيق الواجهة البرمجية
ادمج Broken Link Scan في سير عملك. افحص المواقع واسترجع النتائج وأتمِت المراقبة — كل ذلك عبر واجهة REST API بسيطة.
الرابط الأساسي
https://brokenlinkscan.com/api/v1 المصادقة
تتطلب جميع طلبات الواجهة البرمجية مفتاحاً يُرسَل عبر ترويسة X-Api-Key. ويمكنك توليد مفتاحك من لوحة التحكم.
curl -H "X-Api-Key: your_key" \
https://brokenlinkscan.com/api/v1/sitesحد الطلبات
يُسمح للمستخدمين المُصادَق عليهم بـ300 طلب في الدقيقة. وإذا تجاوزت هذا الحد، تُرجع الواجهة استجابة 429 Too Many Requests.
نقاط النهاية
/api/v1/sites اسرد كل المواقع المراقَبة للمستخدم المُصادَق عليه.
/api/v1/sites أضف موقعاً جديداً للمراقبة.
{ "url": "https://example.com", "name": "My Site" } /api/v1/sites/: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 افحص قائمة روابط جماعياً في طلب واحد.
{ "urls": ["https://a.com", "https://b.com"] } صيغة الاستجابة
كل الاستجابات بصيغة JSON. الطلبات الناجحة تُرجع البيانات مباشرةً، والأخطاء تتضمن حقل رسالة.
{
"data": [...],
"meta": { "page": 1, "limit": 20, "total": 42 }
}{
"error": { "code": 401, "message": "Invalid API key" }
}تحتاج إلى الوصول للواجهة البرمجية؟
واجهة REST API متاحة في باقة Agency. رقِّ باقتك اليوم وابدأ أتمتة مراقبة الروابط المعطلة.
الترقية إلى Agency