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

אתם צופים במסמכי התיעוד של Apigee Edge.
כדאי לעיין במסמכי התיעוד של Apigee X. מידע

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

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

כניסה לפורטל

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

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

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

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

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

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

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

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

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

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

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

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

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

   

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

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

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

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

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

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

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

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

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

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

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

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

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

שינוי הסיסמה

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

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

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

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

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

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

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

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

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

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

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

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

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

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

צפייה במאמרי העזרה של ה-API

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

הסרה עצמית מצוות פיתוח

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

מידע נוסף על:

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

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

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

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

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

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 הוא Active (פעיל). אם מפתח ה-API שלכם דורש אישור ועוד לא אושר, הסטטוס יהיה בהמתנה לאישור.
5. לוחצים על הצגת ה-Secret כדי לראות את ה-Secret.
6. ממקמים את הסמן מעל מפתח ה-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), לוחצים על בעמודה Actions (פעולות) שמשויכת למפתח ה-API שרוצים לבטל.

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

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

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

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

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

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

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

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

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