אתם צופים במסמכי העזרה של Apigee Edge.
כניסה למסמכי העזרה של Apigee X. info
יותר ויותר אנשים משתמשים בפורטלים למפתחים עם תכונות של פרסום ברשתות חברתיות כדי לתקשר עם קהילת המפתחים. המשמעות היא שאפשר להעביר תוכן סטטי, כמו מסמכי עזרה לממשקי API ותנאים וכללים, וגם תוכן דינמי שנוצר על ידי חברי הקהילה, כמו בלוגים ופורומים.
בתור ספקי API, אתם צריכים דרך לחשוף את ממשקי ה-API שלכם, ללמד מפתחים על ממשקי ה-API שלכם, לרשום מפתחים ולאפשר למפתחים לרשום אפליקציות. חשיפת ממשקי ה-API למפתחים היא רק חלק מיצירת קהילה דינמית באמת. בנוסף, צריך לספק לקהילה של המפתחים דרך לשלוח משוב, לבקש תמיכה ולשלוח בקשות להוספת תכונות, וגם לשלוח תוכן משלהם שיהיו למפתחים אחרים גישה אליו.
ב-Apigee Edge יש פורטל של שירותי פיתוח שבעזרתו אפשר ליצור ולהשיק אתר מותאם אישית משלכם כדי לספק את כל השירותים האלה לקהילת הפיתוח שלכם. כל לקוחות Edge יכולים ליצור פורטל למפתחים משלהם, בענן או בארגון.
בסרטון הבא מוצגת הקדמה לפורטל של שירותי המפתחים של Apigee.
באיור הבא מוצג דף הבית של פורטל המפתחים שמוגדר כברירת מחדל:
פורטל המפתחים הוא למעשה מערכת ניהול תוכן (CMS) שמבוססת על הפרויקט בקוד פתוח Drupal (http://www.drupal.org). Drupal מספק קבוצת תכונות ליבה בצורת מודולים שמאפשרים ליצור בקלות תוכן לאתרים ולנהל אותם.
כברירת מחדל, פורטל המפתחים מאפשר ליצור מסמכי תיעוד של ממשקי API, תומך בבלוגים ומספק פורומים עם שרשור. אפשר גם להתאים אישית את פורטל המפתחים בהתאם לדרישות הספציפיות שלכם. התאמה אישית מאפשרת לשנות את המראה של הפורטל וגם את האופן שבו המפתחים מקיימים אינטראקציה עם הפורטל.
את רוב ההתאמות האישיות מבצעים באמצעות התפריט של Drupal. אם מתחברים לפורטל כמשתמשים עם הרשאות אדמין, תפריט Drupal מופיע בחלק העליון של כל דף בפורטל:
האדמינים שולטים בתהליך שבו מפתחים מבקשים גישה לפורטל, באופן שבו המפתחים רושמים את האפליקציות שמקבלות גישה לממשקי ה-API, באופן שבו מקצים למפתחים תפקידים והרשאות ספציפיים שקשורים לממשקי ה-API, ומתי לבטל את הגישה של המפתחים לממשקי ה-API.
בנוסף, דרך פורטל המפתחים אפשר להגדיר ולשלוט למונטיזציה. מונטיזציה מעניקה למפתחים גישה בשירות עצמי ל'חיובים ודוחות', ל'קטלוג ותכניות' ולהגדרות ספציפיות למונטיזציה דרך פורטל המפתחים.
סוגי משתמשי הפורטל
בתמונה הבאה מוצגים שני סוגים של משתמשי פורטל:
- מפתחים הם קהילת המשתמשים שמפתחים אפליקציות באמצעות ממשקי ה-API שלכם. מפתחי אפליקציות משתמשים בפורטל כדי לקבל מידע על ממשקי ה-API שלכם באמצעות SmartDocs, כדי לרשום חשבון בפורטל, כדי לרשום אפליקציות שמשתמשות בממשקי ה-API שלכם, כדי לקיים אינטראקציה עם קהילת המפתחים וגם כדי להציג מידע סטטיסטי על השימוש באפליקציות שלהם בלוח בקרה.
-
צוות ה-API הוא ספק ה-API שיוצר את התוכן בפורטל, מאפשר למפתחי האפליקציות להשתמש בממשקי ה-API שלו, מספק תיעוד של ממשקי ה-API ומספק מנגנון שמאפשר למפתחים לרשום אפליקציות ולקבל מפתחות API. צוות ה-API מבצע הגדרה בסיסית של פורטל המפתחים כדי:
- הגדרת בקשות אוטומטיות או ידניות למפתחות API
- ניהול מסמכי העזרה, הפורומים והבלוגים של ה-API, ואפשרות לערוך את כל השינויים
- ניהול תגובות של משתמשים וניהול פורומים
- לאכוף בקרת גישה מבוססת-תפקידים (RBAC) כדי לשלוט בגישה לתכונות בפורטל. לדוגמה, אדמין יכול להפעיל אמצעי בקרה כדי לאפשר למשתמש רשום ליצור פוסטים בפורום או להשתמש במסופי בדיקה
- התאמה אישית של התראות באימייל לאדמינים ולמפתחים לגבי יצירת משתמשים ואישורים שלהם
- התאמה אישית של טפסים באינטרנט, כמו דפי 'יצירת קשר'
אי אפשר לראות בתרשים הזה את סוג המשתמש השלישי בפורטל – מנהל מוצרי ה-API. מנהל מוצרי ה-API אחראי להגדיר את האופן שבו צוות ה-API יוצר את הפורטל, כולל:
- הגדרת האופן שבו ממשקי API נארזים למוצרים
- הגדרת הכללים לאישור אפליקציות
- אם מופעלת מונטיזציה בפורטל, מגדירים את תוכניות התמחור והחיוב של מוצרי ה-API. מידע נוסף על מונטיזציה זמין במאמר סקירה כללית בנושא מונטיזציה.
התאמה אישית של פורטל המפתחים
כספק API, כדאי לשקול איך להתאים אישית את פורטל המפתחים כך שיתאים בצורה הטובה ביותר לממשקי ה-API שלכם, וגם לספק את המידע הנדרש לקהילת המפתחים שלכם כדי שיוכלו להשתמש בממשקי ה-API. כדאי להביא בחשבון את הדברים הבאים לגבי הפורטל בהתאמה אישית:
- גישה קלה לממשקי ה-API
- מסמכי עזרה, כמו מדריכים ומסמכי עזר
- תוכן שהקהילה תרמה, כמו בלוגים ופורומים
- קוד לדוגמה
- תהליך הרשמה קל שבו אפשר לאשר במהירות מפתחים, אפליקציות וממשקי API חדשים
- זכויות ופרטי כניסה מנוהלים
- בקרת גישה מדורגת
- מראה ותחושה שתואמים לארגון שלכם
הפורטל מגיע עם הגדרה בסיסית מוגדרת מראש. לדוגמה, כברירת מחדל, הפורטל מוגדר לאפשר לכל אחד להירשם כמפתח, אבל אדמין צריך לאשר כל הרשמה כדי שהמפתח יוכל להתחבר לפורטל. לאחר אישור הרישום, המפתח יכול לרשום אפליקציה כדי לבקש מפתח API ולהשתמש בפורטל כדי לגשת למשאבי API.
השלבים בתהליך הרישום שמוגדר כברירת מחדל הם:
- המפתח מתבצע דרך פורטל המפתחים. בתגובה, המערכת שולחת לאדמינים אימייל לאישור החשבון.
- האדמין יאשר את החשבון ויישלח אימייל למפתח כדי להודיע לו שהוא יכול להיכנס עכשיו.
- המפתח רושם אפליקציה ובוחר את מוצרי ה-API שבהם האפליקציה משתמשת. בתגובה, הפורטל מקצה לאפליקציה מפתח API ייחודי.
- המפתח מעביר את מפתח ה-API כששולח בקשות ל-API.
חוויית השימוש הזו מותאמת אישית מאוד. לדוגמה, אפשר לשנות את הסכימה שמוגדרת כברירת מחדל לרישום ולאישור, כך שמפתח חדש יאושר באופן אוטומטי ויתחבר לחשבון אחרי הרישום. לחלופין, אפשר לדרוש מהמפתח לאשר קבוצה של תנאים והגבלות לפני שהוא יוכל להתחבר בפעם הראשונה.
בנוסף, יש לכם שליטה מלאה על התוכן שזמין בפורטל למפתחים. בפורטל המפתחים מוצג תוכן לדוגמה, כמו מסמכי תיעוד של ממשקי API, פוסטים בבלוג ודיונים בפורומים. אתם יכולים לספק תוכן משלכם ולהתאים אישית את המראה של כל סוג תוכן.
מידע נוסף זמין במאמר התאמה אישית של המראה.
ניהול פורטל המפתחים
מפתחים משתמשים בפורטל המפתחים כדי לגשת ל-API שלכם ולהשתמש בו. אדמינים מבצעים משימות של ניהול החשבון, כמו:
- התאמה אישית של תהליך הרישום של המפתחים, כולל שדות הרישום, קוד אימות (captcha) מובנה ואישור אוטומטי או ידני
- הוספה או אישור של מפתחים. כברירת מחדל, כל מפתח יכול להירשם דרך פורטל המפתחים, אבל צריך לקבל אישור מאדמין דרך ממשק המשתמש של פורטל המפתחים. אדמינים יכולים גם ליצור מפתחים ישירות בפורטל. לאחר מכן, המערכת תפרסם הודעה באימייל על כך שנוצר חשבון לפיתוח.
- שינוי של חשבון מפתח. לדוגמה, אדמינים יכולים לשנות את סטטוס החשבון של המשתמש מ'פעיל' ל'חסום', או לשנות את פרטי הפרופיל של המפתח, כמו שם החברה.
- הסרת מפתח. אדמינים יכולים להשבית או למחוק חשבון של מפתח.
- הקצאת תפקידים והרשאות: אדמינים יכולים להקצות תפקיד ספציפי לחשבון פיתוח. תפקיד משויך להרשאות שונות, כמו הרשאה ליצור ספרים או תוכן אחר. אפשר גם לשנות את ההרשאות שמשויכות לתפקיד או ליצור תפקידים חדשים.
מידע נוסף זמין במאמר הוספה וניהול של חשבונות משתמשים.
סיכום של התכונות בפורטל למפתחים
בטבלה הבאה מפורט סיכום של התכונות של פורטל המפתחים:
| תכונה | פרטים |
|---|---|
| תמיכה בדפדפנים | |
|
הרשמת משתמשים |
|
|
ניהול משתמשים |
|
|
מראה הפורטל |
|
|
ניהול תוכן וקהילה |
|
|
הרשאות |
|
|
ניהול מפתחות API |
|
|
אימייל |
|
|
בלוגים |
|
|
פורומים |
|
|
מאמרי עזרה |
|
|
תפריטים |
|
|
חיפוש |
|
|
בודק קישורים |
|