מה זה API (ממשק תכנות יישומים)

הגדרה

API הוא אוסף של יכולות וכללים בתוך תוכנה, שמאפשר לתוכנה אחרת לעבוד איתה, בשונה ממסך שנבנה בשביל אדם. לקריאת API ברשת יש ארבעה חלקים. הכתובת היא נקודת הקצה (Endpoint), כתובת URL אחת מסוימת בתוך ה-API. הפעולה אומרת מה לעשות, למשל GET כדי לקרוא או POST כדי ליצור. המפתח מוכיח מי שואל. התשובה מחזירה בדרך כלל נתונים בפורמט JSON וקוד סטטוס, כמו 200 להצלחה או 404 כשהכתובת לא נמצאה. ממשקי API רבים ברשת בנויים בסגנון נפוץ שנקרא REST. תחשבו על מסעדה: התפריט הוא התיעוד, אתם מזמינים דרך המלצר, ואף פעם לא נכנסים למטבח.

למה זה חשוב

כנראה שלמערכת החשבוניות או הסליקה שאתם כבר עובדים איתה יש API, וטרנזילה, מורנינג (חשבונית ירוקה), iCount ו-Cardcom מפרסמות תיעוד API פומבי. מפתח API הוא סיסמה של תוכנה, ולכן מקומו בהגדרה סודית, לעולם לא באימייל, בהודעת וואטסאפ או בקוד פומבי. ממשקי API רבים מגבילים את מספר הקריאות, וגובים לפי קריאה או לפי חודש מעבר למסלול חינמי. לפני שמשלמים למישהו על בניית חיבור, שאלו שלוש שאלות: האם יש API פומבי, האם יש תוסף או מחבר מוכן, וכמה עולה כל קריאה?

קשור ישירות: Webhook (וובהוק), בק אנד (Back-end), לקוח במחשוב (Client).

טיפים לשיפור

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

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

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