توثيق واجهة API

المصادقة

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

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

curl -H "Authorization: Bearer YOUR_API_KEY" https://issafesite.com/api/v1/scan

عنوان الأساس

https://issafesite.com/api/v1

حدود الطلبات

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

نقاط الوصول

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

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"}'

curl -H "Authorization: Bearer YOUR_API_KEY" "https://issafesite.com/api/v1/scan?page=1&limit=10"

curl -H "Authorization: Bearer YOUR_API_KEY" "https://issafesite.com/api/v1/report?scanId=clx1abc"

استجابات الأخطاء

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

{ "error": "..." }

بدء سريع

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

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"}'

الدعم

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