כרגע מוצג התיעוד של Apigee Edge.
כניסה למסמכי התיעוד של
Apigee X. מידע
יותר ויותר פורטלים למפתחים עם תכונות לפרסום ברשתות חברתיות משמשים לתקשורת עם קהילת המפתחים. הפעילות הזו כוללת העברת תוכן סטטי, כמו תיעוד 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 |
|
|
אימייל |
|
|
בלוגים |
|
|
פורומים |
|
|
מאמרי עזרה |
|
|
תפריטים |
|
|
חיפוש |
|
|
בודק קישורים |
|