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

הדף הזה רלוונטי ל-Apigee ול-Apigee Hybrid.

לעיון במסמכי התיעוד של Apigee Edge

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

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

כניסה לפורטל

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

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

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

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

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

• יצירת חשבון משתמש בפורטל המשולב
• כניסה לפורטל המשולב
• שינוי הסיסמה

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

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

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

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

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

1. עוברים לפורטל.

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

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

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

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

   

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

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

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

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

6. לוחצים על יצירת חשבון.

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

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

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

   הערה: אפשר להגדיר את אישור ההזמנה באימייל, כמו שמתואר במאמר הגדרת התראות באימייל. מומלץ להגדיר את שרת ה-SMTP שמשמש לשליחת התראות באימייל מהפורטל לפני ההשקה, כמו שמתואר במאמר הגדרת שרת ה-SMTP.

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

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

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

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

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

הערות:

• אחרי 24 שעות של חוסר פעילות, תוקף הסשן יפוג, והמשתמש בפורטל ינותק אוטומטית ויידרש להתחבר מחדש.
• אם הגדרתם את הפורטל המשולב כך שנדרשת הפעלה ידנית של חשבונות משתמשים, אתם צריכים להפעיל ידנית את חשבונות המשתמשים לפני שמשתמשי הפורטל יוכלו להיכנס. בשלב הזה, משתמשי הפורטל לא מקבלים שום אינדיקציה לכך שההרשמה שלהם צריכה להיות מופעלת באופן ידני לפני שהם יכולים להיכנס. אם אתם מגדירים הפעלה ידנית, מומלץ להאיץ את ההפעלה של חשבונות משתמשים חדשים.
• כדי לנווט ישירות לדף הכניסה, משתמשים בכתובת ה-URL הבאה:
  https://portal-url/login

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

1. עוברים לפורטל.

2. לוחצים על כניסה. בדף הכניסה מוצג:

   

3. מזינים את כתובת האימייל והסיסמה.

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

שינוי הסיסמה

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

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

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

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

   הערה: כדי להגדיר את שרת ה-SMTP, אפשר לעיין במאמר הגדרת שרת ה-SMTP.

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

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

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

8. לוחצים על יצירת סיסמה חדשה.

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

הערה: זוהי גרסת טרום-השקה של ספק הזהויות SAML.

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

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

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

3. לוחצים על התחברות באמצעות SAML.

   הועברת לספק SAML.

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

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

איך רואים את מאמרי העזרה של ה-API

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

1. עוברים לפורטל.

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

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

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

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

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

הערה: אתם צריכים להירשם לגרסת טרום-השקה של התכונה 'צוותים'.

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

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

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

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

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

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

צפייה בדף Teams

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

כדי לגשת לדף 'צוותים':

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

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

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

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

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

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

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

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

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

   הערה:

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

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

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

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

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

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

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

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

     • לכל צוות פיתוח צריך להיות לפחות בעלים אחד.
     • מספר צוותי הפיתוח המקסימלי שמשתמש יכול להיות חבר בהם הוא 16.

5. לוחצים על Save.

הסרה של עצמכם מצוות פיתוח

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

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

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

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

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

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

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

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

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

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

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

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

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

4. בקטע APIs (ממשקי API), לוחצים על Enable (הפעלה) כדי להפעיל ממשק API אחד או יותר.

   ממשקי ה-API בקטלוג מסווגים כ-Authenticated APIs (ממשקי API שנדרש אימות כדי להשתמש בהם), שנדרשת כתובת URL של קריאה חוזרת כדי להשתמש בהם, או כ-Public APIs (ממשקי API ציבוריים). כדי ליצור אפליקציה, צריך לבחור לפחות API אחד.

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

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

6. לוחצים על Save.

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

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

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

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

מידע נוסף על:

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

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

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

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

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

   הערה: בגרסת הטרום-השקה, אי אפשר להעביר בעלות על אפליקציה אחרי שהיא נוצרת.

6. בקטע API Catalog (קטלוג ה-API), לוחצים על Enable (הפעלה) לצד ממשק API אחד או יותר.

   ממשקי ה-API בקטלוג מסווגים כ-Authenticated APIs (ממשקי API שנדרש אימות כדי להשתמש בהם), שנדרשת כתובת URL של קריאה חוזרת כדי להשתמש בהם, או כ-Public APIs (ממשקי API ציבוריים). כדי ליצור אפליקציה, צריך לבחור לפחות API אחד.

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

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

8. לוחצים על Save.

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

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

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

הערה: בשלב הזה לא מוצגים ממשקי API שלא פורסמו. הבעיה הזו תיפתר בגרסה עתידית.

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

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

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

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

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

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

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

החלפת מפתח 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 (מפתחות API), לוחצים על Revoke (ביטול) בעמודה Actions (פעולות) שמשויכת למפתח ה-API שרוצים לבטל.

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

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

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

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

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

מחיקת אפליקציה

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

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

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