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