ממשק API

חיפוש

ממשק API בביג בוס
 

ממשק API בביג בוס: חיבור האתר או המערכת שלכם ללקוחות, לפריטים, למלאי ולמסמכים

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

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

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

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

 

מדריך עבודה עבור התוסף ממשק API

עשרים וחמישה מדריכים שמכסים את התוסף מקצה לקצה: מההפעלה והמפתח הראשון, דרך מבנה הבקשה והתשובה, סביבת הבדיקה ויומן הקריאות, ועד לקוחות, פריטים, מלאי, מסמכים, ספקים והוצאות, לידים ומשימות, דוחות העסק, הרשמה ל-Webhook, שרת MCP וחיבור של ChatGPT, Claude ו-Gemini.
ארבעת הראשונים הם הבסיס שכדאי לקרוא לפני שמתחילים: מה הממשק עושה, יצירת מפתח, ניהול מפתחות והקריאה הראשונה. השאר מפרטים כל תחום, עם השדות, ההודעות ודוגמאות של בקשות ותשובות.
כל המדריכים נכתבו מתוך המערכת עצמה ומתוך קריאות אמיתיות לממשק, עם שמות הכפתורים וההודעות כפי שהם מופיעים.

להלן רשימת הקישורים במדריך:

– מה עושה ממשק ה-API של ביג בוס, ומה לא

– הפעלת ממשק ה-API ויצירת מפתח גישה ראשון

– ניהול מפתחות: מפתח לכל מערכת, חשבון הכנסה, השבתה ומחיקה

– הקריאה הראשונה ל-API: מבנה הבקשה, התשובה וקודי התשובה

– סביבת בדיקה לממשק ה-API: לבדוק חיבור בלי לגעת בנתונים האמיתיים

– יומן קריאות Api: מה המערכת שלכם שלחה, ומה ביג בוס ענתה

– לקוחות דרך ה-API: הוספה, עדכון, שליפה ויתרה

– פריטים וקטגוריות דרך ה-API

– משיכת כמויות מלאי למערכת חיצונית

– יצירת מסמך מכירה דרך ה-API: סוגים, שורות, מע״מ והנחה

– מסמך עם תקבולים: מזומן, צ'ק, אשראי וניכוי במקור

– שליחת המסמך במייל, קישור הצפייה ומניעת כפילויות

– שליפה, רשימה וביטול מסמכים דרך ה-API

– ספקים דרך ה-API: הוספה, שליפה, רשימה ויתרה

– הוצאות ותשלום לספק דרך ה-API

– קריאת חשבונית ספק מקובץ דרך ה-API

– לידים ומשימות דרך ה-API: ליד מהאתר, שלבים ומשימות

– דוחות העסק דרך ה-API: רווח והפסד, מכירות, גיול ותזרים

– הרשמה ל-Webhook דרך ה-API: הוספה, רשימה ומחיקה

– חיבור Claude ו-Cursor לביג בוס: שרת MCP

– חיבור ChatGPT, Claude ו-Gemini לביג בוס: מה צריך ואיך מתחברים

– חיבור ChatGPT לביג בוס: שרת MCP ב-Plugins, צעד אחר צעד

– חיבור Claude לביג בוס: מחבר מותאם ב-claude.ai, צעד אחר צעד

– חיבור Gemini לביג בוס: מחבר בהתאמה אישית ומצב משימה

– מה לשאול את ChatGPT, Claude או Gemini על העסק שלכם בביג בוס

 

איך זה עובד?

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

  • מפעילים את התוסף: ב"פרופיל משתמש" ← "תוספים" מפעילים את "ממשק Api". אחרי רענון מופיע ב"הגדרות מערכת" הפריט "ניהול ממשק Api", שמוצג רק למנהל מערכת, ומתחתיו "יומן קריאות Api", עם כל בקשה ששינתה נתונים.
  • יוצרים מפתח גישה: ב"רש' מזהים" לוחצים "חדש", נותנים שם, בוחרים הרשאה ("קריאה בלבד", "קריאה וכתיבה" או "קריאה, כתיבה ושליחה ללקוחות"), והמערכת יוצרת מפתח אקראי. המפתח המלא מוצג פעם אחת, בחלון "המפתח נשמר", ולכן מעתיקים אותו מיד. לכל מערכת מתחברת יוצרים מפתח משלה, ואפשר לקבוע לו חשבון הכנסה.
  • מעבירים למפתח/ת: את המפתח ואת כתובת השרת, ותו לא. המפתח נשלח בשדה api_token בגוף כל בקשה.
  • המערכת שלכם פונה לביג בוס: היא שולחת בקשת POST עם JSON, ומקבלת תשובה עם קוד תוצאה, הודעה והנתונים עצמם. כך היא מוסיפה לקוח, שולפת כמות מלאי או יוצרת מסמך.

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

 

המסך הזנת מזהה חדש בביג בוס עם השדות שם מזהה, מתג פעיל, מפתח Api מוסתר וחשבון הכנסה

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

 

פלט של שתי קריאות אמיתיות לממשק ה-API של ביג בוס: שליפת כרטיס לקוח ושליפת כמות מלאי של פריט עם פירוט לפי מחסן

דוגמת בקשה ותשובה אמיתיות: כרטיס לקוח, וכמות המלאי של פריט בכל מחסן.

 

מה אפשר לחבר

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

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

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

למפתחים: קובץ מפרט במבנה OpenAPI 3.1 של פעולות הממשק, עם השדות וההודעות, ואוסף Postman של אותן פעולות: openapi.yaml ו-BigBoss-API.postman_collection.json. הקבצים נכתבים מתוך המערכת עצמה, ולכן הם באנגלית ובעברית, כמו שהממשק עונה.

 

חיבור עוזר AI: ChatGPT, Claude ו-Gemini

עם התוסף אפשר לחבר את ביג בוס גם לעוזר AI, ולשאול אותו על העסק בשפה רגילה: "מי חייב לי כסף?", "כמה הרווחתי מתחילת השנה?". לחיבור הזה לא כותבים קוד: מוסיפים בעוזר את הכתובת של שרת ה-MCP, ומאשרים בביג בוס, ובוחרים מה העוזר יוכל לעשות: "קריאה בלבד", "קריאה, טיוטות ו-CRM" או "קריאה, טיוטות ושליחה ללקוחות". בבדיקה שלנו ChatGPT, Claude ו-Gemini החזירו על החובות של הלקוחות את אותם מספרים כמו מסך גיול החובות. העוזר לא מפיק ולא מבטל מסמכים. בהרשאה "קריאה, טיוטות ו-CRM" הוא יכול להכין טיוטות, לעדכן כרטיסי לקוח ולהכין טיוטת הוצאה, ובהרשאה נפרדת לשלוח ללקוח מסמך שכבר הופק.

הדגמה קצרה בחברת בדיקה: שאלה לעוזר, ותשובה מתוך ביג בוס. שמות הלקוחות בהדגמה מטושטשים.

ההסבר המלא: חיבור ChatGPT, Claude ו-Gemini לביג בוס: מה צריך ואיך מתחברים. המדריך לכל עוזר: ChatGPT, Claude ו-Gemini. ומה אפשר לשאול: מה לשאול את ChatGPT, Claude או Gemini על העסק שלכם בביג בוס.

 

API או Webhook?

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

אתר שצריך להציג מלאי יכול לשאול את ה-API ברגע שגולש פותח עמוד מוצר. מערכת שצריכה לדעת על כל שינוי ברגע שהוא קורה תשתמש ב-Webhook. אפשר להפעיל כל אחד מהם לבד, או את שניהם יחד. ההסבר המלא על Webhook בביג בוס נמצא בעמוד שלו.

 

מה התוסף לא עושה

כדי שלא תתכננו חיבור על יכולת שאינה קיימת, אלה הגבולות היום:

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

 

מדוע לבחור בממשק ה-API של ביג בוס?

  • מפתח נפרד לכל מערכת: אין הגבלה על מספר המפתחות. כל מפתח משביתים או מוחקים בנפרד, והגישה שלו נחסמת מיד, בלי לפגוע במערכות האחרות.
  • חשבון הכנסה לכל מפתח: מסמכים שנוצרים במפתח נרשמים לחשבון ההכנסה שבחרתם לו, וכך ההכנסות מהאתר נפרדות מהכנסות אחרות.
  • מסמך סופי באותו מספור: מסמך שנוצר דרך ה-API הוא סופי, חתום דיגיטלית ומקבל את המספר הבא באותה סדרה של המסמכים מתוך ביג בוס. בקשת מספר ההקצאה מתבצעת לפי אותם כללים כמו במסמך שמופק מהמערכת, והתשובה כוללת את השדות allocation_number ו-allocation_status.
  • מלאי לפי מחסן בתשובה: שליפת הכמות של פריט מחזירה את הסה״כ ואת הכמות בכל מחסן, בקריאה אחת.
  • הגנה ממסמך כפול: מזהה מהמערכת שלכם בשדה request_reference מונע יצירה של אותו מסמך פעמיים, גם כשהבקשה נשלחת שוב.
  • עדכון חלקי של לקוח: שולחים רק את השדות שהשתנו, ושאר הפרטים בכרטיס נשארים כמו שהם.
  • תשובה אחידה וברורה: כל תשובה רגילה מגיעה באותו מבנה, עם קוד תוצאה והודעה בעברית שמסבירה מה קרה.
  • בדיקה ושקיפות: מפתח "קריאה בלבד" למערכת שרק מציגה נתונים, סביבת בדיקה נפרדת עם מפתח משלה לפני שמחברים את הנתונים האמיתיים, ו"יומן קריאות Api" שבו רואים כל בקשה ששינתה נתונים ומה ביג בוס ענתה. מפתח אחד יכול לשלוח עד 120 בקשות בדקה.
  • מייל וקישור צפייה: אפשר לשלוח את המסמך במייל כבר בבקשת היצירה, ובתשובה חוזר קישור לעמוד צפייה במסמך, עם הורדה והדפסה.

 

המסך פרטי המזהה בביג בוס עם חשבון הכנסה שנבחר למפתח והכפתורים חיפוש וברירת מחדל

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

 

התחילו עכשיו!

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

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

כשצריך עזרה – אנחנו איתך!

צוות התמיכה שלנו ישמח

לעמוד לרשותך כאן

מדריכים בנושא ממשק API
מאמרים בנושא ממשק API

45 ימי הניסיון בחינם שלך מתחילים ביצירת חשבון :)

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

🔒 הפרטים מוצפנים ומאובטחים

- נרשמים עכשיו ומתחילים -