StoreChart
מילון מונחים

API

נכתב על ידי צוות StoreChart3 דקות קריאה

בקצרה

API (ממשק תכנות יישומים) הוא חוזה מוגדר שמאפשר לתוכנה אחת לבקש נתונים או פעולות מתוכנה אחרת. הבקשות נשלחות לרוב ב-HTTPS, התשובה חוזרת בפורמט JSON, וההזדהות נעשית באמצעות מפתח גישה. חנויות אונליין משתמשות ב-API כדי לסנכרן הזמנות, מלאי ולקוחות בין החנות, מערכת הניהול, הנהלת החשבונות וכלי התקשורת, בלי הקלדה חוזרת.

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

מה זה API

API (Application Programming Interface) הוא ממשק שמאפשר לתוכנה אחת לקרוא נתונים מתוכנה אחרת או לבצע בה פעולה. הוא מגדיר את הכללים של השיחה בין שתי המערכות:

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

איך API עובד

ברוב המערכות המודרניות API הוא ממשק REST שעובד מעל HTTPS. כל בקשה כוללת ארבעה חלקים:

  • כתובת (endpoint): מזהה את המשאב, למשל רשימת ההזמנות.
  • פעולה (method): GET לקריאה, POST ליצירה, PUT או PATCH לעדכון, DELETE למחיקה.
  • אימות: מפתח API, אסימון Bearer או OAuth, שמוכיחים מי מבקש ומה מותר לו.
  • גוף הבקשה: בפורמט JSON, כשיוצרים או מעדכנים משהו.

קודי סטטוס נפוצים

התגובה מחזירה קוד סטטוס ונתונים:

  • 200: הבקשה הצליחה.
  • 401: המפתח לא תקין.
  • 404: המשאב לא קיים.
  • 429: עברתם את מגבלת הקצב.

דוגמה: הזמנות לגיליון של רואה החשבון

חנות רוצה להעביר כל בוקר את ההזמנות של אתמול לגיליון של רואה החשבון:

  1. סקריפט קטן שולח בקשת GET לרשימת ההזמנות, עם סינון לפי תאריך ועם מפתח הגישה.
  2. הוא מקבל רשימה ב-JSON ורושם שורה לכל הזמנה.
  3. ה-API מחזיר 100 הזמנות בעמוד והיו 340 הזמנות, ולכן הסקריפט צריך ארבע בקשות ומעבר בין עמודים.
  4. במגבלת קצב של 120 בקשות בדקה, ריצה כזו רחוקה מהתקרה. סנכרון מלא של קטלוג גדול כבר צריך להתחשב בה.

API מול webhook

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

API בחנות אונליין

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

טעויות נפוצות

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

API ב-StoreChart

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

שאלות נפוצות

מה ההבדל בין API ל-webhook?

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

צריך לדעת לתכנת כדי להשתמש ב-API?

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

מה זה הגבלת קצב ב-API?

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

StoreChart על הנתונים של החנות שלכם

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