כל מה שקראתם כאן, המערכת עושה בשבילכם בקליק
45 יום לנסות את ביג בוס בחינם. בלי כרטיס אשראי, בלי התקנה: מייל וסיסמה וזהו.
האתר שלכם פונה לביג בוס בעצמו
הזמנה שנכנסת באתר, לקוח חדש שמילא טופס, כמות במלאי שצריך להציג בעמוד מוצר: כשהמערכות לא מחוברות, מישהו מקליד את אותו מידע פעמיים. תוסף ממשק API של ביג בוס מאפשר לאתר, לחנות אינטרנטית או למערכת אחרת לפנות לביג בוס ישירות, כדי להוסיף ולעדכן לקוחות ופריטים, לקרוא כמויות מלאי וליצור מסמכים.
המדריך מסביר מה הממשק עושה, מה צריך כדי לעבוד איתו ומה הוא אינו עושה היום. כדאי לקרוא אותו לפני שמזמינים פיתוח או מתחילים לבנות את החיבור.
שימו לב: מפעילים את התוסף בכרטיס התוספים, ב"פרופיל משתמש" ← "תוספים". העלות לפי המסלול, והפירוט בעמוד המסלולים. בתקופת הניסיון אפשר להפעיל אותו בכרטיס התוספים. התוסף אינו זמין לעוסק פטור, והחיבור עצמו דורש מפתח/ת או מערכת שיודעת לשלוח בקשות API.
מה זה API, בקצרה
API הוא דרך מוסכמת שבה מערכת אחת שולחת בקשה למערכת אחרת ומקבלת תשובה. בביג בוס המערכת שלכם שולחת בקשה עם מפתח גישה, למשל "מה הכמות במלאי של הפריט הזה" או "צור מסמך ללקוח הזה", וביג בוס מחזירה תשובה מסודרת שהקוד שלכם יודע לקרוא.
הבקשה והתשובה הן טקסט במבנה קבוע, ולכן כל מערכת שיודעת לשלוח בקשות API יכולה להתחבר: אתר, חנות אינטרנטית, מערכת הזמנות או אפליקציה שפותחה עבורכם. איך נראית בקשה ומה חוזר בתשובה: הקריאה הראשונה ל-API: מבנה הבקשה, התשובה וקודי התשובה.

דוגמת בקשה ותשובה אמיתיות: שליפת כרטיס לקוח, וכמות המלאי של פריט עם פירוט לפי מחסן.
מה אפשר לעשות דרך הממשק
הפעולות בממשק, ובשפת המפתחים: מתודות, מחולקות לתחומים. העיקריים:
- לקוחות: הוספה, עדכון, שליפת כרטיס, יתרת לקוח, כרטסת ומסמכים פתוחים, ורשימת הלקוחות הפעילים, גם בעמודים, עם חיפוש לפי שם ועם "מה השתנה מאז". הפירוט בלקוחות דרך ה-API: הוספה, עדכון, שליפה ויתרה.
- פריטים וקטגוריות: הוספה, עדכון, שליפה ורשימה של פריטים, והוספה, שינוי שם, שליפה ורשימה של קטגוריות פריטים: פריטים וקטגוריות דרך ה-API.
- מלאי: הכמות של פריט, סה״כ ופירוט לפי מחסן, ורשימת כמויות לכל הפריטים שמנוהלים במלאי. את שתיהן אפשר לבקש גם למחסן אחד. אפשר גם להעביר פריטים בין מחסנים ולשלוח ספירת מלאי, ושתיהן יוצרות מסמך: משיכת כמויות מלאי למערכת חיצונית.
- מסמכים: יצירה בשמונה סוגי מסמכים, עם תקבולים ועם שליחה במייל ללקוח: יצירת מסמך מכירה דרך ה-API: סוגים, שורות, מע״מ והנחה. מסמך שכבר נוצר אפשר לשלוף ולמצוא ברשימה, וחשבונית מס או קבלה גם לבטל: שליפה, רשימה וביטול מסמכים דרך ה-API. במקום מסמך סופי אפשר גם לשמור טיוטה, גם מהצעת מחיר פתוחה. מסמך שכבר הופק אפשר לשלוח ללקוח במייל, במפתח בהרשאה "קריאה, כתיבה ושליחה ללקוחות".
- ספקים: הוספה, שליפה, רשימה ויתרה, עם תוסף מעקב הוצאות: ספקים דרך ה-API: הוספה, שליפה, רשימה ויתרה.
- הוצאות ותשלומים לספקים: רישום הוצאה או טיוטה עם הקובץ מהספק, ותשלום שסוגר אותה: הוצאות ותשלום לספק דרך ה-API. את פרטי החשבונית אפשר לקבל גם מהקובץ עצמו, שנקרא אוטומטית: קריאת חשבונית ספק מקובץ דרך ה-API.
- לידים ומשימות: ליד מטופס באתר, פנייה חוזרת שמצטרפת לליד הקיים, שלבים ומשימות, עם תוסף ניהול לידים ומשימות: לידים ומשימות דרך ה-API: ליד מהאתר, שלבים ומשימות.
- דוחות העסק: רווח והפסד, מכירות לפי לקוח, לפי פריט ולפי חודש, רווח לפי פריט, גיול חובות, תזרים מזומנים צפוי, ומע״מ ומקדמות לתקופה, אותם מספרים כמו בדוחות בביג בוס, גם במפתח "קריאה בלבד": דוחות העסק דרך ה-API: רווח והפסד, מכירות, גיול ותזרים.
- כלים שמתחברים בשרת MCP: Claude, Cursor וכלים דומים קוראים נתונים, כולל דוחות העסק, מכינים טיוטות בלי להפיק, ופותחים ומעדכנים לידים, משימות וכרטיסי לקוח: חיבור Claude ו-Cursor לביג בוס: שרת MCP. ל-ChatGPT, ל-claude.ai ול-Gemini מתחברים גם בלי מפתח בהגדרה, דרך אישור החיבור בביג בוס: חיבור ChatGPT, Claude ו-Gemini לביג בוס.
הממשק עונה, ולא שולח מעצמו
ה-API עונה כשפונים אליו. הוא לא שולח הודעה כשמשהו משתנה בביג בוס. אם האתר צריך לדעת על שינוי, הוא שואל שוב, למשל לפני שהוא מציג עמוד מוצר. כשצריך הודעה ברגע שאירוע קורה, למשל מסמך שהופק או מלאי שעודכן, משתמשים בWebhook, שהוא תוסף נפרד. אפשר להשתמש בכל אחד מהם לבד או בשניהם יחד. את ההרשמה ל-Webhook אפשר לנהל גם מתוך המערכת שלכם, דרך ה-API: הרשמה ל-Webhook דרך ה-API: הוספה, רשימה ומחיקה.
מה צריך כדי להתחיל
- התוסף מופעל. אחרי ההפעלה מופיע ב"הגדרות מערכת" הפריט "ניהול ממשק Api", ושם יוצרים את המפתחות: הפעלת ממשק ה-API ויצירת מפתח גישה ראשון.
- מפתח גישה לכל מערכת. כל מערכת מתחברת מקבלת מפתח משלה, ואפשר להשבית או למחוק אותו בכל רגע: ניהול מפתחות: מפתח לכל מערכת, חשבון הכנסה, השבתה ומחיקה.
- מקום לבדוק בו. סביבת בדיקה נפרדת, עם מפתח משלה, שבה מנסים את החיבור בלי לגעת בנתונים האמיתיים: סביבת בדיקה לממשק ה-API: לבדוק חיבור בלי לגעת בנתונים האמיתיים.
- מי שיבנה את החיבור. מפתח/ת, או מערכת שיודעת לשלוח בקשות API. אין בביג בוס מסך שבונה את החיבור במקומם.

בתפריט "הגדרות מערכת": "ניהול ממשק Api", ומתחתיו "יומן קריאות Api".
מה הממשק לא עושה
כדי שלא תתכננו חיבור על יכולת שאינה קיימת, אלה הגבולות היום:
- אין מחיקה של לקוח, פריט, קטגוריה או מסמך שהופק. דרך ה-API אפשר למחוק רק טיוטה והרשמה ל-Webhook.
- אין עדכון של מסמך. מסמך שנוצר הוא סופי וממוספר. אפשר לשלוף אותו ולמצוא אותו ברשימת מסמכים, וחשבונית מס או קבלה אפשר גם לבטל. ביטול חוזר של מסמך שכבר בוטל לא יוצר מסמך ביטול שני. תיקון של מסמך עושים בתוך ביג בוס.
- אין סליקה דרך ה-API.
- אין מחירונים ואין מחיר לפי לקוח. לכל פריט עובר מחיר מכירה אחד.
- אין מטבע זר. כל הסכומים בשקלים.
- אין כתיבה ישירה של כמויות מלאי. מלאי זז רק דרך מסמך, ובכלל זה העברה בין מחסנים וספירת מלאי שנשלחות דרך ה-API.
- אין הגבלה של מפתח לחלק מהנתונים, חוץ מדוחות העסק. את הדוחות מפתח קורא רק כשלמשתמש שיצר אותו יש הרשאת צפייה בדוחות. כל שאר מה שהממשק חושף פתוח לכל מפתח פעיל. אפשר להגדיר מפתח "קריאה בלבד", שלא יכול ליצור, לעדכן או לבטל דבר. בכל מקרה מוסרים מפתח רק למערכת שסומכים עליה.
מאיפה מתחילים
הצעד הראשון הוא להפעיל את התוסף וליצור מפתח: הפעלת ממשק ה-API ויצירת מפתח גישה ראשון. משם עוברים למדריך הקריאה הראשונה ל-API: מבנה הבקשה, התשובה וקודי התשובה, שמסביר איך נראית בקשה ואיך קוראים את התשובה.
כשבקשה לא עוברת, רואים מה הגיע לביג בוס ומה חזר ב"יומן קריאות Api".
כל שכבת המדריכים מרוכזת בעמוד ממשק API בביג בוס.