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

כרגע מוצג התיעוד של Apigee Edge.
כניסה למסמכי התיעוד של Apigee X. מידע

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

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

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

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

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

שנתחיל בבניית הפורטל?

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

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

התכונה כתובות
נדרש HTTPS ואבטחת שכבת התעבורה (TLS) אכיפה של תקשורת מוצפנת
כולל רישום של דומיין apigee.io עם רשימת סיומות ציבוריות לא ניתן להגדיר קובצי-על בתת-דומיינים של 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)
משתמש באסימוני CSRF מגינים מפני זיוף של בקשות בין אתרים
יתרונות: אמצעי הגנה על נתוני הלקוחות

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

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

בקטעים הבאים תוכלו לקרוא פרטים נוספים.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

תמיכת דפדפן

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