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

אתם צופים במסמכי העזרה של Apigee Edge.
כניסה למסמכי העזרה של Apigee X. info

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

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

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

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

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

תחילת העבודה על הפורטל

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

הדפים הראשונים שכלולים בפורטל לדוגמה כוללים:

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

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

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

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

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

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