מבוא

מדריך ה־API של BeCRM — זמין בחשבון הענן שלכם מעל HTTPS. כל הנתיבים נמצאים תחת /api בכתובת החשבון (למשל https://your-company.example.com/api) ופועלים לפי ארכיטקטורת REST. החליפו את הדומיין בכתובת החשבון שלכם ב־BeCRM.

סוג תוכן
אימות
כותרות
פעולות HTTP נפוצות
עימוד
מגבלת קצב
שדות מותאמים
משאבים
פתרון תקלות

סוג תוכן

כל הבקשות חייבות להיות מקודדות כ־JSON עם הכותרת Content-Type: application/json. רוב התשובות, כולל שגיאות, מוחזרות גם הן כ־JSON בלבד.

אימות

מעבירים את טוקן ה־API בכותרת:

Authorization: Bearer {token}

אימות כושל מחזיר סטטוס 401. כל משתמש שמופעלת לו גישת API יכול ליצור טוקן. בקשות API מתנהגות כמו פעולות באותן הרשאות בממשק.

יצירת טוקן: התחברות לדשבורד → תפריט הפרופיל → טוקני גישה אישיים. לפרטים נוספים ראו אימות.

כותרות

בכל בקשת API יש לכלול:

Accept: application/json
Content-Type: application/json
Authorization: Bearer [API-TOKEN]

חלק מהשירותים/תוספים מוסיפים אוטומטית כותרות Referer או Origin. יש לוודא שהן לא נשלחות בבקשות API חיצוניות — הן מתנגשות עם מנגנון האימות (Laravel Sanctum) ש־BeCRM משתמשת בו. המנגנון בודק כותרות אלה כדי לקבוע אם הבקשה מגיעה מהממשק לצורך CSRF; אם הן קיימות — תקבלו שגיאת CSRF token mismatch.

פעולות HTTP נפוצות

פעולה	תיאור
`GET`	שליפת משאב או רשימה
`POST`	יצירת משאב
`PUT` / `PATCH`	עדכון משאב
`DELETE`	מחיקת משאב

עימוד

בקשות שמחזירות מספר פריטים מחולקות לעמודים של 15 כברירת מחדל. אפשר לבקש עמודים נוספים עם ?page=. בחלק מהמשאבים אפשר גם ?per_page= עד 100. מסיבות טכניות לא כל הנתיבים מכבדים את per_page.

מגבלת קצב

מספר הקריאות מוגבל בחלון זמן. המגבלות מופיעות בכותרות התשובה:

שם כותרת	תיאור
`X-RateLimit-Limit`	מספר הבקשות המותר לדקה
`X-RateLimit-Remaining`	כמה בקשות נשארו בחלון הנוכחי

חריגה מחזירה 429 Too Many Requests.

שדות מותאמים

כשיוצרים שדות מותאמים ב־BeCRM ורוצים למלא אותם דרך API, משתמשים ב־מזהה השדה שהוגדר ביצירה. המזהה נכנס לגוף הבקשה עם ערך לפי סוג השדה:

סוג שדה	סוג ערך	דוגמת מטען
בוליאני	`boolean`	`"field_id": true`
בחירת צבע	`string`	`"field_id": "#333333"`
תיבות סימון	`array`	`"field_id": [5]` — מזהי אפשרויות
תאריך	`date`	`"field_id": "2020-11-26"`
תאריך ושעה	UTC	`"field_id": "2020-11-26 06:00:00"`
אימייל	`string`	`"field_id": "israel@example.com"`
בחירה מרובה	`array`	`"field_id": [5]`
מספר שלם	`integer`	`"field_id": 200`
מספר עשרוני	`decimal(15,3)`	`"field_id": 1250.330`
רדיו	`integer`	`"field_id": 5` — מזהה אפשרות
כתובת URL	`string`	`"field_id": "https://example.com"`
בחירה	`integer`	`"field_id": 10`
טקסט	`string`	`"field_id": "טקסט לדוגמה"`
אזור טקסט	`string`	`"field_id": "טקסט לדוגמה"`
אזור זמן	`string`	`"field_id": "Asia/Jerusalem"`

משאבים

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

פתרון תקלות

CSRF token mismatch

אם מופיעה שגיאת CSRF token mismatch בבקשת API, ודאו:

נשלחת כותרת Accept: application/json
נשלחת כותרת Authorization
כותרות Referer ו־Origin לא נשלחות