FixVibe

// docs / rest api

ממשק REST API

Bearer-authenticated JSON API for scan automation, scan status, and findings. Passive scans are available through REST; active scans are available for paid plans only after the domain is verified and explicitly authorized in the dashboard.

אימות

כל בקשה חייבת לשאת bearer token בכותרת Authorization. טוקנים מונפקים מ-חשבון → טוקני API; הטקסט הגלוי מוצג לכם פעם אחת בדיוק בעת יצירה. ביטול טוקן מחזיר 401 בקריאה הבאה.

bash
curl -H "Authorization: Bearer fxv_..." \
  https://fixvibe.app/api/v1/scans

פורמט הטוקן: fxv_ ואחריו 43 תווי base64url. נשמר במנוחה כגיבוב מסוג SHA-256; הטקסט הגלוי לעולם אינו נשמר בצד השרת.

מגבלות קצב

שני חלונות בכל בקשה מאומתת: פרץ של 10 req/sec וקצב יציב של 60 req/min, שניהם לפי גיבוב של ה-bearer. אכיפת מכסה (תקרות סריקה חודשיות לפי מסלול) שכבה מעל — ראו מכסות ומגבלות.

עימוד

נקודות קצה לרשימות (/api/v1/scans, /api/v1/findings) משתמשות בעימוד מבוסס cursor לפי (created_at, id) בסדר יורד. העבירו ?cursor=<next_cursor> כדי למשוך את העמוד הבא. ה-cursor נשאר נכון תחת כתיבות מקבילות (ללא סטיית OFFSET).

מבני שגיאות

כל שגיאה היא אובייקט JSON עם לפחות מפתח error.

jsonc
{ "error": "invalid_token" }                              // 401
{ "error": "forbidden" }                                  // 403
{ "error": "not_found" }                                  // 404
{ "error": "quota_exceeded", "quota": {...} }             // 429
{ "error": "rate_limited", "retry_after_seconds": 47 }    // 429
{ "error": "invalid_input", "issues": [...] }             // 400

נקודות קצה

התחלת סריקה

POST/api/v1/scans

Enqueues a passive scan by default. For verified domains with active authorization, paid plans can request active mode. Returns immediately with a queued scan id; poll GET /api/v1/scans/[scanId] until status === "completed".

curl -X POST https://fixvibe.app/api/v1/scans \
  -H "Authorization: Bearer fxv_..." \
  -H "content-type: application/json" \
  -d '{"target":"https://staging.example.com"}'

// תגובת 200

{
  "id": "8f1c4e2a-8c3a-4b6f-9c0d-9b1e8f3c2a4d",
  "status": "queued",
  "target": "https://staging.example.com",
  "mode": "passive"
}

רשימת הסריקות שלכם

GET/api/v1/scans

מחזיר סריקות עבור הארגון שמקושר לטוקן הקורא, החדשות ביותר תחילה. עמדו עם ?cursor=. מגבלת ברירת מחדל 50, מקסימום 100.

curl -H "Authorization: Bearer fxv_..." \
  "https://fixvibe.app/api/v1/scans?limit=25"

// תגובת 200

{
  "scans": [
    {
      "id": "8f1c4e2a-...",
      "target_url": "https://staging.example.com",
      "target_hostname": "staging.example.com",
      "mode": "passive",
      "status": "completed",
      "started_at": "2026-05-07T14:00:00Z",
      "completed_at": "2026-05-07T14:00:23Z",
      "findings_count": { "critical": 1, "high": 3, "medium": 7, "low": 2, "info": 4 },
      "triggered_by": "api",
      "created_at": "2026-05-07T14:00:00Z"
    }
  ],
  "next_cursor": "2026-05-07T14:00:00Z:8f1c4e2a-..."
}

קבלת סריקה

GET/api/v1/scans/{scanId}

מחזיר מעטפת סריקה + סיכום חומרה לפי קטגוריה כברירת מחדל. העבירו ?include_findings=true כדי לקבל את הדוח המלא (גדול בסריקות רועשות — העדיפו את נקודת הקצה של ממצאים עם מסננים).

curl -H "Authorization: Bearer fxv_..." \
  https://fixvibe.app/api/v1/scans/8f1c4e2a-8c3a-4b6f-9c0d-9b1e8f3c2a4d

רשימת ממצאים

GET/api/v1/findings

רשימת ממצאים ניתנת לסינון מכל סריקה בארגון של הקורא. מסננים: severity=critical,high, check_id=secrets.patterns, since=2026-04-01T00:00:00Z. עימוד מבוסס cursor.

curl -H "Authorization: Bearer fxv_..." \
  "https://fixvibe.app/api/v1/findings?severity=critical,high&limit=50"

// תגובת 200

{
  "findings": [
    {
      "id": "...",
      "scan_id": "...",
      "check_id": "secrets.js-bundle-sweep",
      "severity": "critical",
      "title": "Supabase service role key exposed in JS bundle",
      "description": "...",
      "evidence": { ... },
      "remediation": "...",
      "cwe_id": "CWE-798",
      "created_at": "2026-05-07T14:00:23Z"
    }
  ],
  "next_cursor": null
}

מפרט OpenAPI

מפרט קריא למכונה ב-/docs/api/openapi (text/yaml). הכניסו אותו ל-codegen המועדף עליכם (openapi-typescript, openapi-python-client, או כל שרשרת כלים של OpenAPI 3.1) כדי לקבל לקוחות טיפוסיים.

ממשק REST API — Docs · FixVibe