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

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

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

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

כניסה לפורטל

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

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

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

.

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

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

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

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

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

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

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

   יופיע הדף 'כניסה'.

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

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

   

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

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

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

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

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

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

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

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

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

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

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

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

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

שינוי הסיסמה

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

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

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

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

6. ללחוץ על הקישור שמופיע בהודעת האימייל לאימות.

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

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

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

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

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

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

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

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

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

הצגת תיעוד של חומרי עזר ל-API

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

דף הקבוצות מוצג ומאפשר לך:

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

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

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

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

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

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

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

7. לוחצים על Create.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

7. לוחצים על Create.

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

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

מידע נוסף על:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

1. בתפריט הנפתח של חשבונות המשתמשים, בוחרים באפשרות Apps (אפליקציות).
2. לוחצים על שם האפליקציה.
3. בקטע 'מפתחות API', לוחצים על בעמודה 'פעולות' שמשויכת למפתח ה-API שרוצים לבטל.

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

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

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

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

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

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

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

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

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