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

הדף הזה רלוונטי ל-Apigee ול-Apigee Hybrid.

לעיון במסמכי התיעוד של Apigee Edge

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

מבוא

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

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

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

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

.

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

מומלץ לנהל את חשבונות המשתמשים ישירות בפורטל למפתחים.

אם אתם משתמשים בפורטל המשולב, זו הדרך היחידה לוודא שחשבונות המשתמשים בפורטל המשולב וב-Apigee יישארו מסונכרנים.

אם אתם משתמשים בפורטל למפתחים שמבוסס על Drupal, ניהול חשבונות משתמשים ישירות בפורטל למפתחים מספק את היתרונות הבאים:

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

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

  • כל שינוי שמתבצע בחשבון המפתח בפורטל נשלח אוטומטית אל Apigee.

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

הסבר על דף המפתחים

גישה לדף Developers (מפתחים) ועיון בו באמצעות ממשק המשתמש של Apigee.

כדי לגשת לדף הפצה > מפתחים:

מעבר אל 'מפתחים'

בדף מפתחים אפשר:

הוספת מפתח

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

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

מידע נוסף זמין במאמר בנושא ניהול משתמשים.

צפייה בפרטי המפתח ועריכתם

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

כדי לראות ולערוך את פרטי המפתח:

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

‫Apigee שומר את הישויות הבאות במטמון למשך 180 שניות לפחות אחרי הגישה לישויות.

  • אסימוני גישה ל-OAuth. המשמעות היא שהרכיב ExpiresIn במדיניות OAuth v2 לא יוכל להגדיר תפוגה של אסימון גישה בפחות מ-180 שניות.
  • ישויות של Key Management Service‏ (KMS) (אפליקציות, מפתחים, מוצרי API).
  • מאפיינים מותאמים אישית בטוקנים של OAuth ובסוגי ישויות של KMS.

ניהול מאפיינים מותאמים אישית למפתחים

אפשר להוסיף עד 18 מאפיינים מותאמים אישית לכל מפתח.

כדי לנהל מאפיינים מותאמים אישית:

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

הפעלה והשבתה של מפתח

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

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

כדי להפעיל או להשבית מפתח:

  1. ניגשים לדף המפתחים.
  2. לוחצים על השורה של המפתח שרוצים להפעיל או להשבית כדי לפתוח את פרטי המפתח.
  3. לוחצים על עריכה.
  4. בקטע 'פרטים', מגדירים את השדה סטטוס לערך פעיל או לא פעיל, לפי הצורך.
  5. לוחצים על Save.
  6. אם המפתח נמצא בכמה ארגונים, חוזרים על השלבים.

ייצוא נתוני פרסום

בקטע הזה מוסבר איך לייצא נתוני פרסום למפתחים, לאפליקציות או למוצרי API כקובץ ערכים מופרדים בפסיקים (CSV) או כקובץ JSON.

דרישות מוקדמות:

  • קטגוריה של Cloud Storage
  • גישת קריאה לנתונים שאתם מייצאים
  • גישת קריאה וכתיבה לקטגוריה של Cloud Storage

מידע נוסף על מאגרי מידע זמין במאמרים הבאים:

כדי לייצא נתוני פרסום:

  1. יוצרים קטגוריה של Cloud Storage או מקבלים את השם של קטגוריה קיימת.
  2. נכנסים לאחד מהדפים הבאים:
  3. לוחצים על ייצוא.
  4. מופיעה תיבת הדו-שיח Save table as. מקלידים את השם של קטגוריית Cloud Storage ומציינים את פורמט הייצוא: JSON או CSV.
  5. לוחצים על Save. מתחילה פעולה ממושכת (LRO). הסטטוס של ה-LRO מוצג בסמל התראה.
  6. אחרי שהייצוא מסתיים, לוחצים על הורדה בהתראה. ייפתח הדף של קטגוריית Cloud Storage שבה נמצא הקובץ.
  7. לוחצים על הורדה. הקובץ יורד למחשב המקומי.
הערות לגבי הנתונים המיוצאים:
  • מבנה הנתונים המיוצאים זהה להגדרות הפרוטו, ולכן אפשר להשתמש במסמכי הפרוטו כהפניה למבני הנתונים המיוצאים. פרטים נוספים:
  • בניגוד לממשק המשתמש של Apigee Classic, לכל משאב יש לחצן ייצוא עצמאי ייעודי.
  • בייצוא CSV לא מופיעים שדות חוזרים או שדות מקוננים מ-proto, כי אי אפשר לייצג אותם בצורה תקינה במבנה נתונים של טבלה. כדי לקבל את המידע הזה, צריך לייצא את הנתונים בפורמט JSON.
  • השם של הקבצים המיוצאים הוא ExportFinal_{hash}.

מחיקת מפתח

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

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

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

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

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

‫Drupal 10: סנכרון מפתחים עם Apigee

ניהול מפתחים באמצעות ה-API

ניהול מפתחים באמצעות ממשקי Developer API.