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

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

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

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

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

מה זה API, בקצרה

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

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

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

מה אפשר לעשות דרך הממשק

בממשק 16 פעולות, ובשפת המפתחים: מתודות. הן מחולקות לחמישה תחומים:

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

הממשק עונה, ולא שולח מעצמו

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

מה צריך כדי להתחיל

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

בתפריט "הגדרות מערכת": "ניהול ממשק Api" לצד "ניהול WebHook".

מה הממשק לא עושה

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

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

מאיפה מתחילים

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

כל שכבת המדריכים מרוכזת בעמוד ממשק API בביג בוס.