אימות

ה-API של SupDesk נמצא בכתובת:

https://api.supdesk.app/v1

כל בקשה מאומתת באמצעות מפתח API שנשלח כאסימון Bearer:

curl https://api.supdesk.app/v1/submissions \
  -H "Authorization: Bearer sd_live_..."

יצירת מפתח

צרו מפתחות בקונסולה תחת הגדרות סביבת העבודה ← מפתחות API. כל מפתח:

• מוגבל לפרויקט בודד — כל מה שאתם קוראים או כותבים דרכו שייך לאותו פרויקט;
• מתחיל בקידומת מזוהה כמו sd_live_, כך שתוכלו לזהות מפתחות בקובצי תצורה בלי לחשוף אותם;
• מוצג פעם אחת בעת היצירה. SupDesk שומרת רק גיבוב (hash) של המפתח — אם איבדתם אותו, בטלו אותו וצרו חדש.

טיפול במפתחות

התייחסו למפתחות API כמו לסיסמאות. קראו ל-API מהשרתים שלכם בלבד — ל-API אין תמיכת CORS, וזה מכוון, כך שהמפתחות אינם שמישים מדפדפנים. אם מפתח דולף, בטלו אותו בקונסולה; הביטול נכנס לתוקף מיד.

אימות שנכשל

מפתח חסר, פגום, מבוטל או לא מוכר מפיק תמיד את אותה תגובה, כך שקוראים אינם יכולים לגשש אילו מפתחות קיימים:

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key."
  }
}

גישת קריאה מול כתיבה

כל התוכניות יכולות לקרוא דרך ה-API. נקודות קצה של כתיבה (POST, PATCH, DELETE) דורשות שסביבת העבודה תהיה בתוכנית בתשלום Pro — ב-Free, פעולות כתיבה מחזירות שגיאת 403 forbidden. ראו מגבלות קצב ושימוש.