title: “HTTP API”
description: “התחבר ל-API הציבורי של Failproof AI Cloud /v1 והשתמש בייצוא הנקודה שנוצר.”
icon: “braces”
ה-API הציבורי מוגש תחת /v1 במקור לוח הבקרה של Failproof AI שלך.
יצירת מפתח וביצוע בקשה
- Dashboard
- CLI
- פתח את Administration → Keys, בחר ב-Create key, ובחר בתור הרשאות הצר ביותר המכסה את האינטגרציה.
- הוסף הקצאות בודדות רק כשנדרש, צור את המפתח, והעתק את הסוד החד-פעמי שלו.
-
בצע בקשת בדיקה ל-
/v1/sessionsוהאשר שהמפתח נשאר פעיל בעמוד Keys. -
סיבוב או השבת את המפתח מתפריט הפעולות שלו כאשר קנייניות האינטגרציה משתנה.
403 ומזהה את ההרשאה החסרה.
בחירת ארגון
מפתח ארגון פועל בארגון שלו באופן אוטומטי. מפתח בהיקף מופע יכול לבחור ארגון לכל בקשה:- Dashboard
- CLI
השתמש במחליף הארגון בכותרת לוח הבקרה לפני פתיחת Administration → Keys. מפתחות שנוצרו שם משייכים לארגון הנבחר. אשר את slug הארגון בתוך ה-URL ופרטי המפתח לפני העתקת האישור להפעלה אוטומטית.
/v1.
המפרט הנוכחי כולל כיסוי מלא של נתיב, שיטה, פרמטר, הרשאה וקוד סטטוס. חלק מגופי התגובה נשארים בכוונה ללא סוג מקומי כי השרת עדיין בונה אותם כ-JSON דינמי. בדוק תגובה ממשית לפני יצירת קליינט מוקלד חזק סביב נקודה ללא סכימת תגובה.
השתמש ב-Content-Type: application/json לכתיבות JSON. התייחס ל-401 כאל אימות חסר או לא חוקי, 403 כזהות תקנית ללא ההרשאה הנדרשת, 404 כמשאב חסר או לא נגיש בארגון, 409 כסכסוך מצב, ו-422 כערך שדה או הרשאה לא חוקי. תגובות שגיאה כוללות הודעה קראה אדם; כשלים בהרשאה גם שם את ההקצאה הנדרשת.