توثيق واجهة API

ابدأ عمليات الفحص واسترجع النتائج والتقارير عبر REST API.

المصادقة

أرسل الترويسة Authorization: Bearer <API_KEY> واحتفظ بالمفتاح بعيداً عن الشيفرة العامة.

نقاط الوصول

ينشئ POST /api/v1/scan فحصاً، ويسرد GET /api/v1/scan الفحوصات، ويسترجع GET /api/v1/report التقارير.

الحدود والأخطاء

التزم بحدود خطتك، وافحص رمز HTTP واستجابة JSON عند حدوث خطأ.

أنشئ المفتاح من لوحة التحكم ← الإعدادات ← مفاتيح API.

https://issafesite.com/api/v1

المجانية: 3 فحوص يومياً و10 طلبات في الدقيقة. Pro: 50 فحصاً يومياً و60 طلباً في الدقيقة. Team: فحوص غير محدودة و300 طلب في الدقيقة.

يتطلب جسم POST الحقل url؛ ويقبل depth القيم QUICK أو STANDARD (الافتراضي) أو DEEP. تدعم القوائم page (الافتراضي 1) وlimit (الافتراضي 20 والحد الأقصى 50)، ويمكن تصفية التقارير باستخدام scanId.

curl -X POST https://issafesite.com/api/v1/scan \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com","depth":"STANDARD"}'

يعيد إنشاء الفحص 202 والقوائم 200. تتضمن أخطاء JSON الحقل error؛ ويعني 401 غياب المفتاح و403 أن المفتاح غير صالح أو منتهي الصلاحية.

اقرأ التفاصيل الكاملة بالإنجليزية