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