יצירת פורטל משולב

אתם צופים במסמכי התיעוד של Apigee Edge.
כדאי לעיין במסמכי התיעוד של Apigee X. מידע

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

לכל המשתמשים ב-Apigee Edge יש גישה לכלי פיתוח משולבים של פורטלים, שמאפשרים להם ליצור במהירות פורטל משלהם למפתחים, כחלופה לפיתוח פורטלים מבוסס Drupal. השוואה בין התכונות של פורטל המפתחים

בסרטון הקצר הזה מוסבר איך ליצור ולפרסם את הפורטל המשולב.

תכונות ויתרונות עיקריים

הפורטל המשולב מספק לכם את התכונות והיתרונות העיקריים הבאים:
תכונה יתרונות
פיתוח תוכן לפורטל פיתוח תוכן לפורטל במהירות ובקלות.
  • יצירת דפים באמצעות עורך הדפים הפשוט לשימוש
  • שימוש ב-Markdown וב-HTML כדי ליצור תוכן
  • הוספת תפריטים לניווט בפורטל
העיצוב של הפורטל התאמה אישית מלאה של המראה והסגנון של הפורטל באמצעות גיליונות סגנון של SCSS ומיתוג מותאם אישית.
תיעוד ממשק API יצירת מאמרי העזרה של ה-API באופן אוטומטי על סמך מפרטי OpenAPI.
רישום בשירות עצמי מאפשרים למפתחים להירשם בשירות עצמי כדי ליצור אפליקציות באמצעות ממשקי ה-API שלכם.
ניהול קהלים קביעת האנשים שיכולים לגשת לתוכן ולממשקי ה-API של הפורטל
Analytics הגדרת Google Analytics ומעקב ניתוחים בהתאמה אישית.
התאמות אישיות מתקדמות ביצוע התאמות אישיות מתקדמות בפורטל, כולל:
  • התאמה אישית של הדומיין
  • הוספה של שדות הרשמה בהתאמה אישית
  • הרחבת הפורטל באמצעות סקריפטים
  • הגדרת האימייל

איך מתחילים לבנות את הפורטל

איך Apigee מטפל באבטחה בפורטל המשולב

בטבלה הבאה מתואר איך Apigee מטפל באבטחה באמצעות תכונות מובנות בפורטל המשולב.

תכונה כתובות
נדרש HTTPS ו-Transport Layer Security ‏ (TLS) אכיפה של תקשורת מוצפנת
כולל רישום דומיין apigee.io עם רשימת סיומות ציבוריות ההגדרה הזו אוסרת על הגדרת קובצי Cookie מסוג Supercookie בתתי-דומיינים של apigee.io
תמיכה בהגדרה של Content security policy‏ (CSP) הגנה מפני פרצת אבטחה XSS‏ (cross-site scripting) ומתקפות אחרות של החדרת קוד
נדרש:
  • ניקוי של קלט בטופס
  • הזרקת JavaScript בכל האתר מוגבלת לאדמינים
הגנה מפני מתקפות הזרקה של HTML,‏ SQL או קצה עורפי
כולל כותרת XSS‏ x-content-type-options: nosniff ההגדרה הזו מונעת מהדפדפנים לנסות לנחש סוגי MIME
כולל כותרת XSS‏ x-frame-options: deny הגדרה שמונעת הטמעה של תוכן מהפורטל ב-iframe
כולל כותרת XSS‏ x-xss-protection: 1 הגדרה שמונעת טעינה של דפים כשהמערכת מזהה מתקפות פרצת אבטחה XSS‏ (cross-site scripting) שמשתקפות
נעשה שימוש בטוקנים של CSRF הגנה מפני זיוף בקשות בין אתרים
היתרונות: אמצעי הגנה על נתוני לקוחות

איך הפורטל המשולב מתקשר עם Edge

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

בקטעים הבאים מוסבר בהרחבה על התהליכים האלה.

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

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

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

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

כל המידע על האפליקציות ומפתחות ה-API מאוחסן ב-Edge, ולכן אדמין של Edge יכול לשנות את המידע באמצעות ממשק המשתמש של Edge או ממשק הניהול של Edge API. לדוגמה, אדמין יכול:

  • הוספה, הסרה או שינוי של אפליקציה למפתחים
  • אישור או ביטול של מפתח API לאפליקציה של מפתח

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

איפה נשמרים הפרטים של חשבון מפַתח האפליקציות

פרטי חשבון הפיתוח מאוחסנים ב-Edge באופן הבא:

הפרטים הבאים של חשבון המשתמש נשמרים ב-Edge:

  • שם ושם משפחה
  • כתובת אימייל
  • שם משתמש
  • סטטוס החשבון בפורטל (פעיל או לא פעיל)
  • תפקיד בפורטל (משתמש מאומת, אדמין, אחר)
  • הרשאות מבוססות-תפקיד
  • צוותים שהמשתמש בפורטל חבר בהם (אם נרשמתם לגרסת הבטא של תכונת הצוותים)

כתובת האימייל היא המפתח הראשי שמשמש את Edge לזיהוי המפתח, וכל כתובת אימייל חייבת להיות ייחודית. מתוך המפתח הראשי, Edge יוצר מזהה מפתח ייחודי לכל ארגון שהמפתח שייך לו.

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

איפה נשמרים פרטי צוות המפתחים (בטא)

כשמשתמש בפורטל יוצר צוות פיתוח בפורטל, פרטי צוות הפיתוח נשמרים ב-Edge, כולל:

  • שם ותיאור של צוות הפיתוח
  • חברי צוות הפיתוח והתפקידים שלהם
  • אפליקציות שהוקצו לצוות המפתחים
  • קהלים שהוקצו לצוות המפתחים
  • השעה שבה נוצר צוות המפתחים

כתובת אימייל ייחודית שנוצרת אוטומטית נוצרת עבור צוות הפיתוח ומשמשת כמפתח הראשי שמשמש את Edge לזיהוי צוות הפיתוח.

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

מידע על פורטל הדוגמה

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

בתמונה הבאה מוצג דף הבית של הפורטל לדוגמה.

דפי ההתחלה שמסופקים עם הפורטל לדוגמה כוללים:

דף תיאור
דף הבית דף הבית של הפורטל שבו מתוארים ממשקי ה-API שמוצגים. משמש כדף הבית שמוגדר כברירת מחדל לפורטל (index.html). הדגמה של שימוש ברכיבי angular material, כמו שמתואר במאמר הוספת רכיבי angular material.
התחלה מהירה סדרה של שלבים להתחלה מהירה שמסבירים איך להתאים אישית את הפורטל. בפורטל לדוגמה, לוחצים על התחלה מהירה כדי להוסיף תוכן לדף שנתחיל?.
שנתחיל? דף תוכן לדוגמה. בפורטל לדוגמה, בדף תחילת העבודה, מוסבר איך לערוך את הדף הזה ולהוסיף אותו לתפריט הניווט העליון.
ממשקי API רשימת ממשקי ה-API הזמינים. כשיוצרים מסמכי עזר אינטראקטיביים ל-API, קישורים לתוכן מתווספים לדף הזה באופן אוטומטי.

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

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

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

תמיכה בדפדפנים

פורטלים משולבים של Apigee תומכים באותן גרסאות דפדפן כמו Apigee Edge.