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

כל מה שקראתם כאן, המערכת עושה בשבילכם בקליק

45 יום לנסות את ביג בוס בחינם. בלי כרטיס אשראי, בלי התקנה: מייל וסיסמה וזהו.

פתחו חשבון: 45 יום חינם
מדריך למשתמש לתוסף ממשק API בביג בוס

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

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

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

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

 

מה זה API, בקצרה

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

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

 

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

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

 

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

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

 

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

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

 

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

 

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

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

 

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

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

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

 

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

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

כשבקשה לא עוברת, רואים מה הגיע לביג בוס ומה חזר ב"יומן קריאות Api".

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

 

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

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

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

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

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

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

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

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

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

45 יום מלאים בלי כרטיס אשראי בלי התחייבות