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