התחלה מהירה עם API
המדריך הזה יוביל אתכם מאפס לבקשה מוצלחת ראשונה: יצירת טוקן אישי, מציאת הכתובת הבסיסית וקריאת REST endpoint.
שלב 1. יצירת טוקן אישי
פתחו את הפרופיל האישי, קטע הטוקנים האישיים, וצרו טוקן חדש (PAT). העתיקו את ערכו מיד — הוא מוצג פעם אחת בלבד ומתחיל בקידומת mbp_. בעת היצירה בחרו הרשאות (scopes) מספיקות למשימתכם; פירוט במדריך האימות.
שלב 2. כתובת בסיסית ופורמט
כל ה-REST endpoint נמצאים תחת הקידומת /api. אין גרסאות בנתיב. גופי בקשות ותגובות הם JSON; העבירו כותרת Content-Type: application/json לבקשות עם גוף. הטוקן מועבר בכותרת Authorization: Bearer mbp_….
שלב 3. בקשה ראשונה — רשימת בוטים
בדקו את הטוקן עם בקשת רשימת הבוטים שלכם. לשם כך נדרש scope bots:read (או *):
curl -H "Authorization: Bearer mbp_הטוקן_שלך" https://הדומיין-שלך/api/bots
בתגובה תגיע מערך JSON של בוטים. אם הטוקן שגוי או פג תוקף — יוחזר 401 עם גוף {"error":"..."} (ראה שגיאות).
שלב 4. מוטציה ראשונה — יצירת תגובה
יצירת תגובה דורשת scope reactions:write. הכניסו את מזהה הבוט משלב 3:
curl -X POST -H "Authorization: Bearer mbp_הטוקן_שלך" -H "Content-Type: application/json" -d '{"name":"שלום","trigger":{"type":"command","value":"/start"}}' https://הדומיין-שלך/api/bots/BOT_ID/reactions
תגובה מוצלחת תחזיר את התגובה שנוצרה עם ה-id שלה. שדות הגוף המדויקים ראו בתיעוד האינטראקטיבי — הוא מייצר דוגמאות מוכנות ב-curl, JavaScript ו-Python לכל endpoint.
שלב 5. הלאה — לפי התיעוד
כשהטוקן עובד, שאר הדברים נוח יותר ללמוד בתיעוד האינטראקטיבי: שם נראית רשימת ה-endpoint המלאה, scopes נדרשים, סכמות גוף וכפתור "Try it".
המשך
- אימות וטוקנים — על PAT, כותרת ו-scopes בפירוט.
- שגיאות — פורמט וקודי מצב.
- עימוד — כיצד לדפדף ברשימות גדולות.