Basic terminology

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

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

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

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

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

החזית שסוכנות ה-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.

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

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

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

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

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

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

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

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

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