איך מפתחי אפליקציות יוצרים אינטראקציה עם הפורטל שלך (הגרסה המקורית)

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

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

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

איך מתבצע מעקב ב-Edge אחרי הרשמה של מפתחי אפליקציות וכניסה לחשבון

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

כשמפתח נרשם באופן עצמאי, המאפיין המותאם אישית _apiportal נוסף להגדרות המפתח והסטטוס של המפתח מוגדר לערך unverified כדי לציין שהמפתח לא נכנס לפורטל. לדוגמה: {"status":"unverified","portals":{}}

בפעם הראשונה שהמפתח נכנס לפורטל, המאפיין המותאם אישית _apiportal מתעדכן כדי לעקוב אחרי שם הפורטל וזמן הגישה, ומגדיר את סטטוס המפתח כactive. בכל פעם שהמפתח נכנס לפורטל, המאפיין המותאם אישית מתעדכן כדי לאפס את הערך של lastVisit (בפורמט epoch) עבור הפורטל הזה. לדוגמה: {"status":"active","portals":{"myorg-myportal":{"lastVisit":1480972935}}}

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

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

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

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

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

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

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

3. לוחצים על הרשמה.
   מוצגת תיבת הדו-שיח הבאה.

   

4. מזינים את הפרטים הנדרשים (שם פרטי, שם משפחה וכתובת אימייל).

5. לוחצים על יצירה.
   מוצגת תיבת הדו-שיח הבאה.

   

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

כניסה לפורטל

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

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

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

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

4. לוחצים על כניסה.
   מוצגת תיבת הדו-שיח הבאה.

   

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

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

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

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

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

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

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

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

4. לוחצים על המתג Access כדי להפעיל או להשבית את הגישה למוצר API מהאפליקציה.

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

5. לוחצים על בקשה כדי לבקש אישור למוצר API שעדיין לא אושר.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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