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

כרגע מוצג התיעוד של 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, כפי שמתואר ברישום מפתחי אפליקציות.

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

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

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

    יצירת חשבון

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

  5. לוחצים על Create.
    תיבת הדו-שיח הבאה תופיע.

    התחברות לפורטל

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

כניסה לפורטל

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

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

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

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

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

    כניסה לפורטל

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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