API והפניית מפתחים
RedCloud חושפת REST API כדי שתוכלו להפעיל סריקות, לשלוף ממצאים ולנהל דוחות באופן תוכנתי. החלק הזה הוא הפניית המפתחים.
בחלק הזה
Section titled “בחלק הזה”- אימות — מפתחות API וכיצד לשלוח אותם.
- הרשאות והיקפים — מה כל מפתח יכול לעשות, תחת עקרון ההרשאות המינימליות.
- נקודות קצה — נקודות הקצה הזמינות ב-REST עם פורמטי בקשה/תגובה.
- מגבלות קצב — מכסות בקשות והתנהגות retry מומלצת.
מוסכמות
Section titled “מוסכמות”ה-API מוגש על ידי שרת ה-FastAPI. כל הבקשות מאומתות, מורשות ותחומות ל-Tenant; בעלות לא ידועה נדחית כברירת מחדל. התגובות הן JSON, ושגיאות מחזירות הודעות מובְנות עם Correlation ID לצורך תמיכה.