Skip to Content

פניות

הפניות הן דיווחי הבאגים ובקשות היכולות של הפרויקט שלכם — אותם פוסטים שהמשתמשים שלכם יוצרים בפורטל, חשופים לקריאה ולכתיבה דרך ה-API. (למשוב כללי יש נקודת קצה משלו; ראו משוב.)

כל נקודות הקצה דורשות אימות ומוגבלות לפרויקט של מפתח ה-API.

רשימת פניות

GET/v1/submissions

ParameterTypeDescription
statusstringסינון לפי סטטוס: backlog, open, planned, in_progress או done.
typestringסינון לפי סוג: bug או feature.
limitintegerגודל עמוד. ברירת המחדל היא 20.
offsetintegerמספר הפריטים לדילוג. ברירת המחדל היא 0.
curl "https://api.supdesk.app/v1/submissions?status=open&limit=10" \ -H "Authorization: Bearer sd_live_..."

התגובות משתמשות במעטפת הרשימה הסטנדרטית:

{ "data": [ { "id": "8f7a…", "type": "bug", "title": "Export button unresponsive on Safari", "body": "Clicking Export does nothing on Safari 26.", "status": "open", "is_private": false, "created_at": "2026-07-01T09:12:00Z" } ], "pagination": { "limit": 10, "offset": 0, "has_more": false } }

קבלת פנייה

GET/v1/submissions/:id

מחזיר פנייה בודדת כ-{ "data": { … } }, או שגיאת 404 not_found.

יצירת פנייה

Pro גישת כתיבה דורשת תוכנית בתשלום; ב-Free זה מחזיר 403 forbidden.

POST/v1/submissions

ParameterTypeDescription
typerequiredstringbug או feature.
titlerequiredstringסיכום קצר של הפנייה.
emailrequiredstringהאימייל של משתמש הקצה שאליו שייכת הפנייה.
bodystringתיאור ארוך יותר.
namestringשם תצוגה למשתמש הקצה.
localestringהשפה למיילי ההתראה שזה מפעיל (en, ar, de, es, fr, he, hi, it, ja, ru, zh). ברירת המחדל היא en.
curl -X POST https://api.supdesk.app/v1/submissions \ -H "Authorization: Bearer sd_live_..." \ -H "Content-Type: application/json" \ -d '{ "type": "bug", "title": "Export button unresponsive on Safari", "email": "jamie@example.com", "body": "Clicking Export does nothing on Safari 26." }'

מחזיר 201 עם הפנייה שנוצרה. משתמש הקצה נוצר (או מותאם לפי אימייל) ברשימת הלקוחות של הפרויקט שלכם אוטומטית.

פניות שנוצרו נספרות במכסת הפניות החודשית שלכם בדיוק כמו פניות מהפורטל. בתקרה, נקודת הקצה הזו מחזירה 429 limit_reached — אלא אם כן בסביבת העבודה שלכם מופעלת חריגת פניות, ואז הפנייה מתקבלת ומחויבת. ראו מגבלות קצב ושימוש.

Last updated on