NAGISOT API למפתחים

הטמיעו את כל מערכת הנגישות שלנו בכל פלטפורמת צד-שלישי. REST, OpenAPI 3.1, MCP, ו-SDK רשמיים — בלי לבנות מחדש את הגלגל.

llms.txt llms-full.txt @nagisot/mcp GitHub

התחלה מהירה

שלוש שורות שמכניסות נגישות מלאה לכל אתר:

<!-- נדבק לכל אתר. רק החליפו YOUR_SITE_ID. -->
<script src="https://nagis.doogree.co.il/widget.js"
        data-site="YOUR_SITE_ID"
        defer></script>

// app/layout.tsx (Next.js) או src/main.tsx (Vite)
import Script from 'next/script';

export default function Layout({ children }) {
  return (
    <html>
      <body>
        {children}
        <Script
          src="https://nagis.doogree.co.il/widget.js"
          data-site={process.env.NEXT_PUBLIC_NAGISOT_SITE}
          strategy="afterInteractive"
        />
      </body>
    </html>
  );
}

// functions.php של הערכת נושא
add_action('wp_footer', function() {
  ?>
  <script src="https://nagis.doogree.co.il/widget.js"
          data-site="YOUR_SITE_ID" defer></script>
  <?php
});

# דרך ה-API: קבלת קונפיגורציה של ווידג'ט לאתר
curl https://api.nagis.doogree.co.il/v1/widget-config/SITE_ID \
  -H "Authorization: Bearer pk_live_..."

אימות (API Keys)

צרו מפתח בלוח הניהול. שלוש שיטות להעביר אותו, נבדקות בסדר הזה:

# 1) Bearer token (מומלץ)
Authorization: Bearer pk_live_ABC123...

# 2) Header ייעודי
X-API-Key: pk_live_ABC123...

# 3) Query parameter (כשה-CORS חוסם headers)
?api_key=pk_live_ABC123...

סוגי מפתחות

pk_live_* — production, מחויב לפי שימוש
pk_test_* — sandbox, לא מחויב לעולם, מחזיר נתוני דמה ב-AI endpoints

Scopes

widget:read / widget:write — קונפיגורציית הווידג'ט
scan:read / scan:write — סריקות נגישות
ai:use — endpoints מבוססי AI (alt-text, simplify, captions)
* — הכל (מפתח admin)

מסלולים ומגבלות

טוען מ-/v1/tiers…

קודי שגיאה

400 invalid_request          // body פגום או חסר שדה חובה
401 unauthorized | invalid_key  // אין token או שלא מתקבל
402 quota_exceeded            // מכסה חודשית — כולל upgrade_url
403 origin_not_allowed        // Origin לא ברשימה
403 insufficient_scope        // scope חסר — כולל missing[]
403 feature_not_available     // צריך tier גבוה יותר — כולל required_tier
404 not_found
429 rate_limited              // כולל retry_after_seconds
503 db_unavailable            // Cloudflare D1 לא זמין רגעית

כל תשובת שגיאה היא JSON תקני:

{
  "error": "quota_exceeded",
  "resource": "ai_calls",
  "used": 100, "limit": 100,
  "upgrade_url": "https://nagis.doogree.co.il/pricing"
}

Endpoints

טוען מ-/v1/openapi.json…

MCP Server

הטמיעו את NAGISOT ב-Claude Code, Cursor או Zed עם MCP. ה-AI עצמו ינהל את הקונפיגורציה ויפעיל סריקות:

// ~/.claude/claude_desktop_config.json
{
  "mcpServers": {
    "nagisot": {
      "command": "npx",
      "args": ["-y", "@nagisot/mcp"],
      "env": { "NAGISOT_API_KEY": "pk_live_..." }
    }
  }
}

Tools זמינים: nagisot_whoami, nagisot_tiers, nagisot_get_widget_config, nagisot_set_widget_config, nagisot_usage, nagisot_scan.

SDKs

JavaScript / TypeScript — @nagisot/sdk (בקרוב)
Python — nagisot ב-PyPI (בקרוב)
REST — זמין עכשיו, ראו את ה-OpenAPI Spec

Webhooks (בקרוב — Pro+)

קבלו התראות אירועים: scan.completed, fix.needs_approval, quota.warning, quota.exceeded.