Basic terminology

ממשק תכנות יישומים (API) – ממשק שמאפשר לאפליקציה אחת לצרוך בקלות יכולות או נתונים מאפליקציה אחרת.

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

‫Apigee מספקת מידע רב על ממשקי API ושיטות מומלצות לפיתוח ולשימוש בהם. כדי להתחיל, אפשר לצפות בשידור האינטרנט בנושא עיצוב API או להוריד את הספר האלקטרוני בחינם Web API Design: The Missing Link Best Practices for Crafting Interfaces that Developers Love.

ממשק facade ב-Edge עבור API אחד או יותר, שירותי HTTP כלליים או אפליקציות (כמו Node.js).

proxy ל-API מיושם כקבוצה של קובצי תצורה, כללי מדיניות וקוד שמסתמכים על קבוצה של משאבים שסופקו על ידי Apigee Edge. אפשר ליצור ולשנות הגדרות של שרתי proxy של API באמצעות ממשק ניהול המשתמש של Apigee Edge, או להטמיע אותם באופן מקומי בעורך טקסט או בסביבת פיתוח משולבת (IDE).

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

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

כדי להקל על ניהול ממשקי ה-API, ‏ Apigee מוסיף לכתובות ה-URI הגולמיות האלה שמות ותיאורים לתצוגה. ‫Edge מאפשר לכם לצרף מדיניות וקוד לכתובות URI, וכך לשלוט בהתנהגות של ממשקי ה-API ולנהל אותה בצורה פרטנית.

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

מפתח API מקושר למוצר API אחד או יותר, וכך נוצר קישור בין אפליקציה לבין חבילת כתובות ה-URI שהאפליקציה מורשית להשתמש בהן.

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

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

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

• סביבת הבדיקה משמשת בדרך כלל לפריסת שרתי proxy ל-API במהלך הפיתוח.
• בדרך כלל משתמשים בסביבת prod כדי לקדם שרתי proxy של API מסביבת הבדיקה אחרי שהם פותחו ונבדקו באופן מלא.

מאגר לכל האובייקטים בחשבון Apigee Edge, כולל שרתי proxy ל-API, מוצרי API, חבילות API, אפליקציות ומפתחים.

צריך חשבון משתמש לכל ארגון שאתם חברים בו. (לרוב המשתמשים יהיה חשבון רק בארגון אחד).

שלב עיבוד שמופעל כיחידת לוגיקה אטומית וניתנת לשימוש חוזר בתהליך העיבוד של שרת Proxy של API.

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

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

הגרסה של ממשק ה-API שפונה למפתחים.

לדוגמה, pivotaltracker.com/services/v3 או api.enterprise.apigee.com/v1.

המונח הזה שונה מrevision, שהוא חבילה ממוספרת של הגדרות ומדיניות עם בקרת גרסאות, שמאוגדת ב-API Proxy. לממשקי API יש גרסאות, ולשרתי proxy ל-API יש גרסאות.