Vigilbase للمطورين
البدء السريع
شغّل فحصًا غير تدخلي لترويسات الأمان دون مصادقة:
curl -sS -X POST https://vigilbase.com/api/v1/agent/tools/security-headers/execute \
-H "Content-Type: application/json" \
-d '{"target":"https://example.com"}'فحص مصادقة البريد الإلكتروني:
curl -sS -X POST https://vigilbase.com/api/v1/agent/tools/email-security/execute \
-H "Content-Type: application/json" \
-d '{"target":"example.com"}'CLI: npx @vigilbase/cli run security-headers https://example.com --json
المصادقة ونطاقات الصلاحيات
يحصل المستدعون المجهولون على نطاقات صلاحيات الفئة المجانية tools:read, tools:execute، وbadges:read بمعدل 10 طلبات في الدقيقة لكل عنوان IP.
مفاتيح API اختيارية للمطورين (تُنشأ على one.vigilbase.com/developers) ترفع الحد إلى 30 طلبًا في الدقيقة. المفاتيح محددة النطاق بحسب المستخدم — فهي مرتبطة بحسابك في Vigilbase One، ولا تتبع مؤسسة. أرسل Authorization: Bearer <key> أو X-Api-Key: <key>.
tools:read— سرد أدوات الوكلاءtools:execute— تشغيل الفحوصات المدرجة في قائمة السماحbadges:read— شارات درجات الأمان
مفاتيح API للمطورين
أنشئ مفاتيح API مجانية في Vigilbase One؛ يستغرق التسجيل دقيقة ولا يتطلب نموذج مبيعات. المفاتيح محددة النطاق بحسب المستخدم، وتشمل tools:read, tools:execute، و badges:read، وترفع حد طلبات الوكلاء إلى 30 طلبًا في الدقيقة على vigilbase.com.
curl -sS https://vigilbase.com/api/v1/agent/tools \ -H "Authorization: Bearer YOUR_ONE_API_KEY"
نقاط نهاية API
GET /api/v1/agent/tools— فهرس الأدواتPOST /api/v1/agent/tools/security-headers/executePOST /api/v1/agent/tools/email-security/executePOST /api/v1/developer/keys— مهمل؛ أنشئ المفاتيح في One بدلًا من ذلكGET /api/badge/{domain}— شارة SVGGET /openapi.json— مستند OpenAPI 3.1
قديم /api/agent/* لا تزال الأسماء البديلة تعمل وتُرجع Deprecation / Sunset كترويسات تشير إلى البديل في الإصدار v1.
أخطاء JSON ذات أنواع محددة
تُرجع حالات الفشل application/problem+json (RFC 9457) مع رمز قابل للمعالجة آلياً code، ونص قابل للقراءة البشرية message/detail، وبشكل اختياري hint للتعافي.
{
"success": false,
"error": {
"code": "rate_limit_exceeded",
"message": "Rate limit exceeded. Retry after the indicated delay.",
"hint": "Free tier allows 10 requests/minute. Create a developer API key on One for a higher limit."
},
"type": "https://vigilbase.com/developers/errors/rate-limit-exceeded",
"title": "Rate Limit Exceeded",
"status": 429,
"detail": "Rate limit exceeded. Retry after the indicated delay.",
"code": "rate_limit_exceeded",
"retryAfterSec": 12
}حدود المعدل
تتضمن الاستجابات RateLimit و RateLimit-Policy، بالإضافة إلى ترويسات RateLimit-Limit / RateLimit-Remaining / RateLimit-Reset وX-RateLimit-* كأسماء بديلة. وتحدد استجابة HTTP 429 قيمة Retry-After.
الإصدارات والإهمال التدريجي
الإصدار الرئيسي الحالي هو v1 ضمن /api/v1/. وتتضمن الاستجابات API-Version: 1. ستصدر التغييرات غير المتوافقة مع الإصدارات السابقة ضمن /api/v2/. وتعلن الأسماء البديلة غير المرقمة والمهملة عن Deprecation: true, a Sunset، وترويسة Link rel="successor-version" للإشارة إلى الإصدار اللاحق.
متى تستخدم واجهات API لدى Vigilbase
- قيّم ترويسات أمان HTTP أو مصادقة البريد الإلكتروني (SPF وDKIM وDMARC) من وكيل دون التحكم في متصفح
- ضمّن شارة لدرجة أمن موقع جرى قياسها سابقًا
- اكتشف مهارات الوكلاء عبر
/.well-known/agent-skills/index.json
استخدم واجهة المتصفح (مع التحقق من البريد الإلكتروني) للفاحصات التدخلية مثل website-security وreact2shell.