Skip to Content

בטא

הריצו תוכניות בטא פרטיות ונהלו את רשימת הבודקים שלהן. דורש שיכולת הבטא תהיה מופעלת בפרויקט.

תוכניות

GET/v1/beta/programs

ParameterTypeDescription
statusstringסינון לפי סטטוס: draft, active או closed.
limitintegerגודל עמוד. ברירת המחדל היא 25.
offsetintegerמספר הפריטים לדילוג. ברירת המחדל היא 0.

GET/v1/beta/programs/:id

POST/v1/beta/programs

ParameterTypeDescription
namerequiredstringשם התוכנית. ה-slug בכתובת נגזר ממנו ונעשה ייחודי בתוך הפרויקט.
versionstringגרסת semver הנבדקת (X.Y.Z).
summarystringתיאור קצר של הבטא.
access_urlstringהיכן הבודקים ניגשים לגרסה (למשל קישור TestFlight).
access_instructionsstringכיצד הבודקים מתארגנים.
statusstringdraft, active או closed. ברירת המחדל היא draft.
allow_public_signupbooleanמאפשר הצטרפות ציבורית דרך קישור הפורטל. ברירת המחדל היא false.
feedback_deadlinestringחותמת זמן ISO-8601 שאחריה המשוב נסגר.

PATCH/v1/beta/programs/:id

ParameterTypeDescription
namestringשם התוכנית.
versionstringגרסת semver הנבדקת (X.Y.Z).
summarystringתיאור קצר של הבטא.
access_urlstringהיכן הבודקים ניגשים לגרסה.
access_instructionsstringכיצד הבודקים מתארגנים.
statusstringdraft, active או closed.
allow_public_signupbooleanמאפשר הצטרפות ציבורית דרך קישור הפורטל.
feedback_deadlinestringחותמת זמן ISO-8601 שאחריה המשוב נסגר.

DELETE/v1/beta/programs/:id

בודקים

GET/v1/beta/programs/:programId/testers

ParameterTypeDescription
statusstringסינון לפי סטטוס: invited, joined, declined או revoked.
limitintegerגודל עמוד. ברירת המחדל היא 25.
offsetintegerמספר הפריטים לדילוג. ברירת המחדל היא 0.

GET/v1/beta/programs/:programId/testers/:id

POST/v1/beta/programs/:programId/testers

ParameterTypeDescription
emailrequiredstringהאימייל של הבודק שיש לרשום.

DELETE/v1/beta/programs/:programId/testers/:id

פעולות כתיבה דורשות גישת API בתוכנית בתשלום Pro. ה-slug נגזר מ-name של התוכנית ונעשה ייחודי בתוך הפרויקט. רישום בודק הוא אידמפוטנטי לפי אימייל ומחזיר את אסימון האישור token — ה-API אינו שולח מייל, אז השתמשו בו כדי לבנות את קישור ההצטרפות בפורטל (/beta/join?token=...) ולמסור אותו בעצמכם. DELETE מחזיר 204; מחיקת תוכנית מוחקת בשרשור את הבודקים והמשוב שלה, ומחיקת בודק היא לצמיתות.

רשימת תוכניות

curl "https://api.supdesk.app/v1/beta/programs?status=active&limit=10" \ -H "Authorization: Bearer sd_live_..."
{ "data": [ { "id": "bp_abc123", "project_id": "prj_9f2a", "name": "Mobile App v2", "version": "2.0.0", "slug": "mobile-app-v2", "summary": "Early access to the new mobile experience.", "access_url": "https://testflight.apple.com/join/abcd", "access_instructions": "Install TestFlight, then open the invite link.", "status": "active", "allow_public_signup": true, "feedback_deadline": "2026-08-01T00:00:00Z", "created_at": "2026-07-01T09:12:00Z" } ], "pagination": { "limit": 25, "offset": 0, "has_more": false } }

יצירת תוכנית

curl -X POST https://api.supdesk.app/v1/beta/programs \ -H "Authorization: Bearer sd_live_..." \ -H "Content-Type: application/json" \ -d '{ "name": "Mobile App v2", "version": "2.0.0", "summary": "Early access to the new mobile experience.", "status": "active", "allow_public_signup": true }'
{ "data": { "id": "bp_abc123", "project_id": "prj_9f2a", "name": "Mobile App v2", "version": "2.0.0", "slug": "mobile-app-v2", "summary": "Early access to the new mobile experience.", "access_url": null, "access_instructions": null, "status": "active", "allow_public_signup": true, "feedback_deadline": null, "created_at": "2026-07-01T09:12:00Z" } }

עדכון תוכנית

רק השדות שאתם שולחים משתנים; שדות שהושמטו נשארים ללא שינוי.

curl -X PATCH https://api.supdesk.app/v1/beta/programs/bp_abc123 \ -H "Authorization: Bearer sd_live_..." \ -H "Content-Type: application/json" \ -d '{ "status": "closed" }'
{ "data": { "id": "bp_abc123", "project_id": "prj_9f2a", "name": "Mobile App v2", "version": "2.0.0", "slug": "mobile-app-v2", "summary": "Early access to the new mobile experience.", "access_url": null, "access_instructions": null, "status": "closed", "allow_public_signup": true, "feedback_deadline": null, "created_at": "2026-07-01T09:12:00Z" } }

מחיקת תוכנית

curl -X DELETE https://api.supdesk.app/v1/beta/programs/bp_abc123 \ -H "Authorization: Bearer sd_live_..."

מחזיר 204 No Content. מוחק בשרשור את הבודקים של התוכנית ואת המשוב שלהם.

רשימת בודקים

curl "https://api.supdesk.app/v1/beta/programs/bp_abc123/testers?status=invited" \ -H "Authorization: Bearer sd_live_..."
{ "data": [ { "id": "bt_def456", "beta_program_id": "bp_abc123", "email": "jamie@example.com", "token": "9d8c7b...", "source": "invite", "status": "invited", "end_user_id": null, "invited_at": "2026-07-02T10:00:00Z", "joined_at": null } ], "pagination": { "limit": 25, "offset": 0, "has_more": false } }

רישום בודק

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

curl -X POST https://api.supdesk.app/v1/beta/programs/bp_abc123/testers \ -H "Authorization: Bearer sd_live_..." \ -H "Content-Type: application/json" \ -d '{ "email": "jamie@example.com" }'
{ "data": { "id": "bt_def456", "beta_program_id": "bp_abc123", "email": "jamie@example.com", "token": "9d8c7b...", "source": "invite", "status": "invited", "end_user_id": null, "invited_at": "2026-07-02T10:00:00Z", "joined_at": null } }

השתמשו ב-token שמוחזר כדי לבנות את קישור ההצטרפות בפורטל (/beta/join?token=...) ולשלוח אותו במייל בעצמכם.

הסרת בודק

curl -X DELETE https://api.supdesk.app/v1/beta/programs/bp_abc123/testers/bt_def456 \ -H "Authorization: Bearer sd_live_..."

מחזיר 204 No Content. הסרת בודק היא לצמיתות ומוחקת את משוב הבטא שלו.

Last updated on