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

אתם צופים במסמכי העזרה של Apigee Edge.
כניסה למסמכי העזרה של Apigee X. info

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

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

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

כניסה לפורטל

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

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

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

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

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

    כניסה לפורטל

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

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

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

  1. בתפריט הנפתח של המשתמש, בוחרים באפשרות האפליקציות שלי.
  2. לוחצים על + אפליקציה כדי ליצור אפליקציה חדשה.
  3. מזינים שם ותיאור לאפליקציה בתיבת הדו-שיח Create App (יצירת אפליקציה).
  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. לוחצים על Create (יצירה) בתיבת הדו-שיח כדי לאשר את הפעולה.
  7. אפשר גם להשבית את מפתח ה-API, כפי שמתואר בהמשך.

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

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

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

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

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

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

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

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

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

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

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

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