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