אתם צופים במסמכי התיעוד של Apigee Edge.
כדאי לעיין במסמכי התיעוד של Apigee X. מידע
פרסום הוא התהליך של הפיכת ממשקי ה-API שלכם לזמינים למפתחי אפליקציות לצורך שימוש.
סרטון: בסרטון הבא מוצג מבוא כללי לפרסום באמצעות API.
פרסום ממשקי API כולל את המשימות הבאות, שמתוארות בנושא הזה:
- יוצרים ב-Edge את מוצרי ה-API שכוללים את ממשקי ה-API.
- רישום מפתחי אפליקציות ב-Edge.
- רישום אפליקציות למפתחים ב-Edge.
- לספק תיעוד ותמיכה מהקהילה לממשקי ה-API.
משימה 1: יצירת מוצר API ב-Edge
המשימה הראשונה בתהליך הפרסום היא ליצור מוצר API. מוצר API הוא אוסף של משאבי API שמוצעים כמארז למפתחי אפליקציות לשימוש. יוצרים מוצרי API באמצעות Edge Management API או ממשק המשתמש. (במאמר מהו מוצר API? מוסבר מהם מוצרי API).
באיור הזה, ה-API מורכב משני מוצרים, שכל אחד מהם מכיל שלושה משאבי API.
בתור ספקי API, אתם אחראים ליצירת ממשקי ה-API ומוצרי ה-API כדי לטפל בבקרת גישה, בהגבלות שימוש ובכל דרישה עסקית אחרת. לדוגמה, יכול להיות שתרצו:
- השקת מוצר API חינמי שמאפשר גישת קריאה בלבד למשאבי ה-API שלו.
- להשיק מוצר API שני במחיר הרצפה שמאפשר גישת קריאה/כתיבה לאותם משאבי API כמו בגרסה החינמית, אבל עם מגבלת גישה נמוכה, כמו 1,000 בקשות ביום.
- פרסום מוצר API שלישי במחיר גבוה יותר שמאפשר גישת קריאה/כתיבה לאותו משאב API, אבל עם מגבלת גישה גבוהה.
חשוב לזכור: Edge מאפשר לכם ליצור מוצרי API שתואמים לדרישות העסקיות של ממשקי ה-API שלכם.
מידע נוסף על יצירת מוצרי API זמין במאמר יצירת מוצרי API.
משימה 2: רישום מפתח אפליקציות ב-Edge
מפתח יוצר את האפליקציות שמשתמשות בממשקי ה-API שלכם. מפתחי אפליקציות נרשמים ב-Apigee Edge לפני שהם יכולים לרשום את האפליקציה שלהם. כשהם רושמים את האפליקציה, הם מקבלים מפתח API שיאפשר לאפליקציה גישה ל-API.
במהלך תהליך רישום האפליקציה, אתם קובעים למי תהיה גישה לממשקי ה-API שלכם. בכל שלב, אתם יכולים למחוק מפתח אפליקציה, וכך לבטל את כל מפתחות ה-API שמשויכים למפתח הזה, ולמנוע ממנו גישה לממשקי ה-API שלכם.
אתם, כספקי API, מחליטים איך לרשום מפתחים. לדוגמה, אפשר להשתמש בתהליך רישום ידני שבו מפתח פוטנציאלי צריך ליצור קשר עם הארגון כדי להירשם. המפתח הפוטנציאלי צריך לספק את כל הפרטים הנדרשים, כמו כתובת אימייל, שם פרטי, שם משפחה ושם החברה. אם תאשרו את הבקשה של המפתח, תוכלו להשתמש בממשק המשתמש של Edge Management כדי לרשום את המפתח באופן ידני. מידע נוסף זמין במאמר בנושא ניהול מפתחי אפליקציות.
בנוסף, Apigee מספקת כלים שבהם אפשר להשתמש כדי להפוך את תהליך הרישום של המפתחים לאוטומטי. לדוגמה:
- משתמשים ב-Apigee Edge management API כדי לשלב פונקציונליות של הרשמה באתר הקיים. ממשק Edge Management API הוא API בארכיטקטורת REST שמאפשר לבצע את כל הפעולות בתהליך הרישום של מפתחים. מידע נוסף זמין במאמר שימוש ב-Edge Management API לפרסום ממשקי API.
- משתמשים בפורטל Apigee Developer Services כדי לרשום מפתחים. בפורטל יש תמיכה מובנית ברישום מפתחים, אבל יש בו גם הרבה תכונות אחרות לתמיכה בממשקי ה-API שלכם. מידע נוסף זמין במאמר מהו פורטל למפתחים?
משימה 3: רישום אפליקציית מפתח ב-Edge
כדי שאפליקציה תוכל לגשת לממשקי ה-API שלכם, צריך לרשום אותה ב-Edge. עם זאת, רק מפתח רשום יכול לרשום אפליקציה ב-Edge.
בזמן רישום האפליקציה, המפתח בוחר מוצר API אחד או יותר. לדוגמה, אתם יכולים לפרסם כמה מוצרי API שמתאימים לסוגים שונים של שירותים ותוכניות תמחור. מפתחי האפליקציות יכולים לבחור מתוך רשימת מוצרי ה-API הזמינים.
בתגובה לרישום האפליקציה ב-Edge, המערכת מקצה לאפליקציה מפתח API ייחודי. האפליקציה צריכה להעביר את מפתח ה-API הזה כחלק מכל בקשה למשאב API. המפתח מאומת, ואם הוא תקף, הבקשה מאושרת. בכל שלב, אתם כספקי השירות יכולים לבטל את המפתח כדי שהאפליקציה לא תוכל יותר לגשת לממשקי ה-API שלכם.
ספקי API מחליטים איך הם רוצים לרשום אפליקציות. תוכל:
- שימוש בתהליך ידני שבו המפתח יוצר קשר עם הארגון כדי לרשום את האפליקציה שלו. בתגובה, אתם שולחים למפתח את מפתח ה-API, יכול להיות שבאמצעות אימייל.
- אתם יכולים להשתמש ב-Edge Management API כדי לשלב באתר שלכם פונקציונליות של רישום אפליקציות ומסירת מפתחות.
- בחשבון Edge בתשלום, משתמשים בפורטל Apigee Developer Services, שכולל תמיכה מובנית ברישום אפליקציות ובמסירת מפתחות API.
מידע נוסף זמין במאמר בנושא הרשמת אפליקציות וניהול מפתחות API.
משימה 4: תיעוד של ממשקי ה-API
כשמפרסמים מוצרי API, חשוב לספק תיעוד ומנגנון למשוב ממפתחים. פורטלים למפתחים עם תכונות של פרסום ברשתות החברתיות משמשים יותר ויותר לתקשורת עם קהילת המפתחים. זה כולל תקשורת של תוכן סטטי, כמו מאמרי העזרה של ה-API ותנאים והגבלות, וגם תוכן דינמי שנוצר על ידי הקהילה, כמו בלוגים ופורומים, וגם תכונות של תמיכת לקוחות.
אתם יכולים לבנות אתר משלכם כדי להציג את התיעוד, או אם יש לכם חשבון Edge בתשלום, אתם יכולים להשתמש בפורטל Apigee Developer Services. הפורטל כולל תמיכה מובנית בתיעוד, בבלוגים, בפורומים ובסוגים אחרים של תוכן שנדרשים לתמיכה בקהילת המפתחים שלכם.
SmartDocs מאפשר לכם לתעד את מאמרי העזרה של ה-API בפורטל Developer Services באופן אינטראקטיבי לחלוטין. תיעוד אינטראקקטיבי עם SmartDocs מאפשר למשתמשי הפורטל:
- מידע על ה-API
- שליחת בקשה בזמן אמת ל-API
- הצגת תשובה בזמן אמת שמוחזרת מה-API
לדוגמה, באיור הבא מוצג API שמתועד בפורטל באמצעות SmartDocs. ממשק ה-API הזה מספק מידע על מזג האוויר במיקום ספציפי:
המפתח מזין ערך לפרמטר השאילתה w כדי לציין את המיקום, ואז לוחץ על הלחצן שליחת הבקשה כדי לראות את הבקשה והתגובה בזמן אמת. כשיוצרים תיעוד אינטראקקטיבי של ממשקי ה-API, קל למשתמשי הפורטל ללמוד, לבדוק ולהעריך את ממשקי ה-API.
Edge management API הוא API בארכיטקטורת REST שמאפשר לכם לגשת לשירותי API באמצעות כל לקוח HTTP. Apigee משתמש ב-SmartDocs כדי ליצור תיעוד אינטראקטיבי ל-Edge Management API. כאן אפשר לעיין במאמרי העזרה של ה-API.
מידע נוסף זמין במאמר בנושא שימוש ב-SmartDocs לתיעוד ממשקי API.