סיכום השינויים לפרסום

כרגע מוצג התיעוד של Apigee Edge.
כניסה למסמכי התיעוד של Apigee X.
מידע

פרסום הוא תהליך שבו ממשקי ה-API יהיו זמינים לשימוש למפתחי אפליקציות.

סרטון: הסרטון הבא מספק מבוא כללי לפרסום באמצעות API.

הפרסום של ממשקי API כולל את המשימות הבאות, שמתוארות בנושא הזה:

  1. צרו ב-Edge את מוצרי ה-API שמרכזים את ממשקי ה-API שלכם.
  2. רישום מפתחי אפליקציות ב-Edge.
  3. רישום אפליקציות למפתחים ב-Edge.
  4. לספק תיעוד ותמיכה מהקהילה עבור ממשקי ה-API שלך.

משימה 1: יצירת מוצר API ב-Edge

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

תרשים רצף משמאל לימין שבו מוצגים מפתח, אפליקציה, ממשקי API ושירותים לקצה העורפי. סמל ה-API והמשאבים מודגשים. קו מקווקו
    שמצביע מהמפתח לסמל של אפליקציה שהמפתח יצר. חצים מהאפליקציה
 וחזרה לאפליקציה מציגים את תהליך הבקשה והתגובה לסמל API, עם מפתח אפליקציה שממוקם
 מעל הבקשה. סמל ה-API והמשאבים מודגשים. מתחת לסמל ה-API יש שתי קבוצות
    של נתיבי משאבים שמקובצים לשני מוצרי API: מוצר מיקום ומוצר מדיה.
    במוצר 'מיקום' יש משאבים עבור /country, /cities, וכן /languages, ובמוצר המדיה יש משאבים עבור /books, /כתבי עת ו /סרטים. משמאל ל-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 ושירותים לקצה העורפי. סמל המפתח מודגש. קו מקווקו מנוקד
    מהמפתח המודגש אל סמל של אפליקציה שהמפתח יצר. חצים מהאפליקציה
 וחזרה לאפליקציה מציגים את תהליך הבקשה והתגובה לסמל API, עם מפתח אפליקציה שממוקם
 מעל הבקשה. מתחת לסמל ה-API יש שתי קבוצות
    של נתיבי משאבים שמקובצים לשני מוצרי API: מוצר מיקום ומוצר מדיה.
    במוצר 'מיקום' יש משאבים עבור /country, /cities, וכן /languages, ובמוצר המדיה יש משאבים עבור /books, /כתבי עת ו /סרטים. משמאל ל-API נמצאים המשאבים לקצה העורפי שה-API קורא, כולל מסד נתונים, אפיק שירות ארגוני, שרתי אפליקציות וקצה עורפי גנרי.

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

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, עם מפתח אפליקציה שממוקם
 מעל הבקשה. סמל ה-API והמשאבים מודגשים. מתחת לסמל ה-API יש שתי קבוצות
    של נתיבי משאבים שמקובצים לשני מוצרי API: מוצר מיקום ומוצר מדיה.
    במוצר 'מיקום' יש משאבים עבור /country, /cities, וכן /languages, ובמוצר המדיה יש משאבים עבור /books, /כתבי עת ו /סרטים. משמאל ל-API נמצאים המשאבים לקצה העורפי שה-API קורא, כולל מסד נתונים, אפיק שירות ארגוני, שרתי אפליקציות וקצה עורפי גנרי.

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

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

בתור ספקי API, אתם מחליטים איך לרשום אפליקציות. תוכל:

  • צריך להשתמש בתהליך ידני שדורש מהמפתח ליצור קשר עם הארגון שלך כדי לרשום את האפליקציה. בתגובה, יש לשלוח למפתח את מפתח ה-API, אולי באימייל.
  • אפשר להשתמש ב-Edge Management API כדי לשלב באתר שלך את הפונקציונליות של רישום האפליקציה ואת מסירת המפתחות.
  • לחשבון Edge בתשלום, צריך להשתמש בפורטל Apigee Developer Services, שכולל תמיכה מובנית לרישום אפליקציות ולמסירת מפתחות API.

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

משימה 4: תיעוד ממשקי ה-API

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

תרשים רצף משמאל לימין שבו מוצגים מפתח, אפליקציה, ממשקי API ושירותים לקצה העורפי. סמל המפתח מודגש. מתחת למפתח מופיעה תיבה
    שמייצגת פורטל למפתחים. הפורטל כולל תיעוד API, דוגמאות, מדריכים, חומרי עזר ל-API ועוד. הפורטל מכיל גם בלוגים, פורומים ופורטל תמיכה.
    קו מקווקו של המפתח המודגש לצד סמל של אפליקציה שהמפתח
    יצר. חצים באפליקציה וחזרה לאפליקציה מציגים את תהליך הבקשה והתגובה לסמל API,
    עם מפתח אפליקציה שממוקם מעל הבקשה. מתחת לסמל ה-API יש שתי קבוצות
    של נתיבי משאבים שמקובצים לשני מוצרי API: מוצר מיקום ומוצר מדיה.
    במוצר 'מיקום' יש משאבים עבור /country, /cities, וכן /languages, ובמוצר המדיה יש משאבים עבור /books, /כתבי עת ו /סרטים. משמאל ל-API נמצאים המשאבים לקצה העורפי שה-API קורא, כולל מסד נתונים, אפיק שירות ארגוני, שרתי אפליקציות וקצה עורפי גנרי.

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

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

  • מידע נוסף על ה-API
  • שליחת בקשה פעילה ל-API
  • הצגת תגובה פעילה שהוחזרה מה-API

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

נושא בשיטת SmartDocs API שמאפשר להפעיל ממשק API של מזג אוויר על ידי לחיצה על לחצן
    בנושא.

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

ה-Edge Management API הוא ממשק API ל-REST שמאפשר לגשת לשירותי API באמצעות כל לקוח HTTP. ב-Apigee משתמשים ב-SmartDocs כדי ליצור תיעוד אינטראקטיבי עבור ממשק ה-API לניהול Edge. תוכלו לעיין במסמכי התיעוד בנושא API כאן.

מידע נוסף זמין במאמר שימוש ב-SmartDocs לתיעוד ממשקי API.