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

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

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

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

כניסה לפורטל

בקטעים הבאים נסביר איך משתמשי הפורטל נכנסים לפורטל המורחב באמצעות פרטי הכניסה שלהם (ספק זהויות מובנה) או באמצעות SAML (בטא).

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

כניסה לפורטל באמצעות פרטי כניסה של משתמש (ספק זהויות מובנה)

כשספק הזהויות המובנה מופעל, משתמשי הפורטל יכולים להיכנס לפורטל המשולב באמצעות פרטי הכניסה שלהם (שם משתמש וסיסמה), כפי שמתואר בקטעים הבאים:

יצירת חשבון משתמש בפורטל המשולב

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

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

  1. נכנסים לפורטל.

  2. לוחצים על כניסה.

    מוצג דף הכניסה.

  3. לוחצים על Create account.

    מוצג הדף 'יצירת חשבון'.

    תיבת הדו-שיח של יצירת החשבון

  4. ממלאים את הטופס.

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

  5. קוראים את התנאים ומאשרים אותם.

  6. לוחצים על Create Account (יצירת חשבון).

  7. ממלאים את טופס ה-CAPTCHA ולוחצים על אימות (אם הוא מוצג).

    חשבון המשתמש נוצר ונשלח אימייל לאישור.

  8. תוך 10 דקות, לוחצים על הקישור באימייל האישור כדי להשלים את תהליך ההרשמה.

    אם לא תלחצו על הקישור תוך 10 דקות, תצטרכו לחזור על השלבים האלה כדי ליצור חשבון ולקבל שוב את ההודעה.

  9. נכנסים לפורטל המשולב (כפי שמתואר בהמשך).

כניסה לפורטל המשולב

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

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

  1. עוברים לפורטל.
  2. לוחצים על כניסה. בדף הכניסה מוצגים הפרטים הבאים: דף הכניסה
  3. מזינים את כתובת האימייל והסיסמה.
  4. לוחצים על כניסה.

שינוי הסיסמה

כשמשתמשים בספק הזהויות המובנה, משתמשי הפורטל משנים את הסיסמה באופן הבא:

  1. עוברים לפורטל.
  2. לוחצים על כניסה.
  3. לוחצים על Reset Password.
  4. מזינים את כתובת האימייל של החשבון שרוצים לאפס.

  5. לוחצים על Send Reset Password Link (שליחת קישור לאיפוס הסיסמה).

    קישור לאיפוס הסיסמה יישלח לאימייל.

  6. לוחצים על הקישור באימייל האישור.

  7. מזינים את הסיסמה החדשה ומאשרים אותה.

    סיסמאות חייבות להיות באורך 8 תווים לפחות, ולכלול לפחות אחד מכל אחד מהפריטים הבאים: מספר, אות קטנה, אות גדולה ותו מיוחד.

  8. לוחצים על Create New Password.

כניסה לפורטל באמצעות אימות SAML (בטא)

כשספק הזהויות ב-SAML מופעל, משתמשי הפורטל נכנסים לפורטל המשולב באמצעות אימות SAML, באופן הבא:

  1. עוברים לפורטל.
  2. לוחצים על כניסה.

  3. לוחצים על login with SAML.

    המערכת מפנה אתכם לספק SAML.

  4. אם מופיעה בקשה, מזינים את פרטי הכניסה של ספק הזהויות ב-SAML.

הצגת מאמרי העזרה של ה-API

משתמשי הפורטל יכולים לראות את מאמרי העזרה של ה-API שפרסמתם בפורטל, באופן הבא:

  1. נכנסים לפורטל.

  2. לוחצים על APIs (ממשקי API) בסרגל הניווט העליון. הדף APIs מוצג. לדוגמה:

    הדף APIs

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

  4. לוחצים על כרטיס API כדי להציג את מאמרי העזרה של ה-API. מסמכי העזרה של ה-API מוצגים.

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

שיתוף האחריות על אפליקציה באמצעות צוותי מפתחים (בטא)

צוותי פיתוח מאפשרים למשתמשי הפורטל לשתף את האחריות על אפליקציה עם משתמשי פורטל אחרים. בקטעים הבאים מוסבר איך יוצרים צוותי פיתוח ומנהלים אותם.

מידע על התפקידים בצוות הפיתוח

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

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

הצגת הדף 'צוותים'

בדף 'צוותים' מוצגים צוותי המפתחים שאתם חברים בהם.

כדי לגשת לדף Teams:

  1. נכנסים לפורטל.
  2. בתפריט הנפתח של חשבון המשתמש בפורטל, בוחרים באפשרות Teams.

בדף Teams תוכלו:

הוספת צוותי מפתחים

כדי להוסיף צוות פיתוח:

  1. נכנסים לפורטל.
  2. בתפריט הנפתח של חשבון המשתמש בפורטל, בוחרים באפשרות Teams.
  3. לוחצים על + צוות חדש.
  4. מזינים שם ותיאור.

  5. כדי להוסיף חבר לצוות הפיתוח, לוחצים על + Add another member, מזינים את כתובת האימייל של משתמש הפורטל ובוחרים תפקיד בצוות הפיתוח.

    חוזרים על הפעולה כדי להוסיף עוד חברים.

  6. כדי למחוק חבר מצוות הפיתוח, לוחצים על סמל המחיקה לצד חבר צוות הפיתוח שרוצים למחוק.

  7. לוחצים על יצירה.

עריכת החברים והתפקידים בצוות הפיתוח

כדי לערוך את החברים והתפקידים בצוות המפתחים:

  1. נכנסים לפורטל.
  2. בתפריט הנפתח של חשבון המשתמש בפורטל, בוחרים באפשרות Teams.
  3. לוחצים על השורה של צוות הפיתוח שרוצים לערוך ושאתם הבעלים שלו.

  4. מבצעים אחד או יותר מהשלבים הבאים:

    • עורכים את השם, התיאור ואיש הקשר הראשי.
    • להוסיף או להסיר חברים לצוות הפיתוח.
    • עדכון התפקידים של חברי צוות הפיתוח.

  5. לוחצים על שמירה.

איך מסירים את עצמכם מצוות פיתוח

כדי להסיר את עצמכם מצוות מפתחים:

  1. נכנסים לפורטל.
  2. בתפריט הנפתח של חשבון המשתמש בפורטל, בוחרים באפשרות Teams.
  3. לוחצים על השורה של צוות הפיתוח שממנו רוצים להסיר את עצמכם.
  4. לוחצים על עזיבת הצוות.

מחיקת צוות מפתחים

כדי למחוק צוות מפתחים:

  1. נכנסים לפורטל.
  2. בתפריט הנפתח של חשבון המשתמש בפורטל, בוחרים באפשרות Teams.
  3. לוחצים על השורה של צוות הפיתוח שרוצים למחוק.
  4. לוחצים על סמל המחיקה.
  5. לוחצים על אישור כדי לאשר את המחיקה.

רישום אפליקציות

רושמים אפליקציות למפתחים ואפליקציות לצוותים של מפתחים, כפי שמתואר בסעיפים הבאים.

רישום אפליקציות למפתחים

משתמשי הפורטל יכולים לרשום אפליקציות לשימוש בממשקי ה-API שפרסמתם, באופן הבא:

  1. בתפריט הנפתח של חשבון המשתמש, בוחרים באפשרות אפליקציות.
  2. לוחצים על + אפליקציה חדשה כדי ליצור אפליקציה חדשה.
  3. מזינים שם ותיאור לאפליקציה בתיבת הדו-שיח 'אפליקציה חדשה'.

  4. בוחרים את הבעלים של האפליקציה בתפריט הנפתח Owner.

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

  5. בקטע API Catalog, בוחרים ממשק API אחד או יותר.

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

  6. אם בוחרים ממשק API בקטע Authenticated APIs (ממשקי API מאומתים), מזינים כתובת URL לקריאה חוזרת (callback).

    מידע נוסף זמין במאמר מידע על כתובות URL לשיחות חזרה.

  7. לוחצים על יצירה.

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

חברי צוות הפיתוח יכולים לרשום אפליקציות בשביל צוות הפיתוח כדי להשתמש בממשקי ה-API שפרסמתם, כפי שמתואר בהמשך.

מידע נוסף על:

כדי לרשום אפליקציות של צוות הפיתוח:

  1. בתפריט הנפתח של חשבון המשתמש, בוחרים באפשרות Teams.
  2. לוחצים על השורה של צוות הפיתוח שעבורו רוצים לרשום אפליקציה.
  3. לוחצים על + אפליקציה חדשה כדי ליצור אפליקציה חדשה.
  4. מזינים שם ותיאור לאפליקציה בתיבת הדו-שיח 'אפליקציה חדשה'.

  5. בוחרים את הבעלים של האפליקציה בתפריט הנפתח Owner.

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

  6. בקטע API Catalog, בוחרים ממשק API אחד או יותר.

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

  7. אם בוחרים ממשק API בקטע Authenticated APIs (ממשקי API מאומתים), מזינים כתובת URL לקריאה חוזרת (callback).

    מידע נוסף זמין במאמר מידע על כתובות URL לשיחות חזרה.

  8. לוחצים על יצירה.

ניהול ממשקי ה-API באפליקציה

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

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

משתמשי הפורטל יכולים לנהל את ממשקי ה-API באפליקציה מהפורטל, באופן הבא:

  1. בתפריט הנפתח של חשבון המשתמש, בוחרים באפשרות אפליקציות.
  2. לוחצים על האפליקציה ברשימה.
  3. בקטע APIs, לוחצים על סמל ההפעלה או על סמל ההשבתה כדי להפעיל או להשבית את הגישה ל-API מהאפליקציה, בהתאמה.
  4. בממשק API מאומת, מוסיפים או עורכים את כתובת ה-URL להודעת החזרה, לפי הצורך.

הצגת מפתח ה-API והסוד של אפליקציה

משתמשי הפורטל יכולים לנהל את מפתח ה-API של אפליקציה מהפורטל, באופן הבא:

  1. בתפריט הנפתח של חשבון המשתמש, בוחרים באפשרות אפליקציות.
  2. לוחצים על האפליקציה ברשימה.
  3. מפתחות ה-API מוצגים בקטע API Keys.
  4. מוודאים שהסטטוס של מפתח ה-API הוא 'פעיל'. אם מפתח ה-API דורש אישור ועדיין לא אושר, הסטטוס יופיע כבהמתנה לאישור.
  5. לוחצים על Show secret (הצגת הסוד) כדי להציג את הסוד.
  6. מעבירים את הסמן מעל מפתח ה-API או הסוד ולוחצים על delete-icon כדי להעתיק אותו ללוח.

החלפת מפתח ה-API של אפליקציה

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

משתמשי הפורטל יכולים לבצע רוטציה של מפתח API לאפליקציה מהפורטל, באופן הבא:

  1. בתפריט הנפתח של חשבון המשתמש, בוחרים באפשרות אפליקציות.
  2. לוחצים על האפליקציה ברשימה.
  3. בקטע API Keys, לוחצים על Add Key.
  4. לוחצים על אישור בתיבת הדו-שיח כדי לאשר את הפעולה.
  5. לחלופין, אפשר לבטל את מפתח ה-API הישן, כפי שמתואר בהמשך.

ביטול מפתח API לאפליקציה

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

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

  1. בתפריט הנפתח של חשבון המשתמש, בוחרים באפשרות אפליקציות.
  2. לוחצים על שם האפליקציה.
  3. בקטע API Keys, לוחצים על סמל הביטול בעמודה Actions שמשויכת למפתח ה-API שרוצים לבטל.

  4. לוחצים על אישור כדי לאשר את הפעולה.

    הסטטוס של המפתח מתעדכן ל'בוטל'.

עריכת פרטי האפליקציה

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

  1. בתפריט הנפתח של חשבון המשתמש, בוחרים באפשרות אפליקציות.
  2. לוחצים על האפליקציה ברשימה.
  3. עורכים את השדות 'שם' או 'תיאור' בכרטיסייה 'פרטי האפליקציה'.
  4. מנהלים את ממשקי ה-API באפליקציה, לפי הצורך.
  5. לוחצים על שמירה.

איך מוחקים אפליקציה?

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

  1. בתפריט הנפתח של חשבון המשתמש, בוחרים באפשרות אפליקציות.
  2. לוחצים על האפליקציה ברשימה.
  3. לוחצים על מחיקה.
  4. לוחצים על אישור כדי לאשר את הפעולה.

האפליקציה נמחקת ומוסרת מרשימת האפליקציות.