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

אתם קוראים את מאמרי העזרה של Apigee Edge.
כדאי לעיין במסמכי העזרה בנושא Apigee X. מידע

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

מבוא

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

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

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

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

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

הכרת הדף 'אפליקציות'

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

Edge

כדי לגשת לדף האפליקציות באמצעות ממשק המשתמש של Edge:

  1. נכנסים לחשבון בכתובת apigee.com/edge.
  2. בסרגל הניווט הימני, בוחרים באפשרות פרסום > אפליקציות.

יוצג הדף 'אפליקציות'.

כפי שמודגש באיור, בדף האפליקציות אפשר:

‫Classic Edge (ענן פרטי)

כדי לגשת לדף 'אפליקציות' באמצעות ממשק המשתמש של Classic Edge:

  1. מתחברים אל http://ms-ip:9000, כאשר ms-ip היא כתובת ה-IP או שם ה-DNS של צומת שרת הניהול.
  2. בסרגל הניווט העליון, בוחרים באפשרות פרסום > אפליקציות למפתחים.

יופיע הדף 'אפליקציות למפתחים'.

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

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

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

אפליקציות רשומות נוספות אל:

כדי לרשום אפליקציה ב-Edge:

  1. ניגשים לדף האפליקציות.
  2. לוחצים על + אפליקציה.
  3. מציינים את פרטי האפליקציה:
    שדה תיאור חובה?
    שם שם האפליקציה. אי אפשר לשנות את השם אחרי שהאפליקציה נוצרת. השם הזה משמש לקריאות ל-API לניהול. כן
    השם המוצג השם לתצוגה של האפליקציה שמופיע בממשק הניהול של Edge ובפורטל למפתחים. לא
    חברה/מפתח

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

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

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

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

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

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

צפייה באפליקציה ועריכה שלה

כדי להציג ולערוך אפליקציה:

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

ניהול פרטי הכניסה

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

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

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

איך רואים מפתח API וסוד

כדי לראות מפתח API ו-API Secret:

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

אישור או ביטול של מפתח API

קריאות ל-API ל-API proxies בדרך כלל דורשות מפתח API. ‫Edge מאפשר את הקריאות רק אם מפתח ה-API אושר, תקף ועומד בתנאים שהוגדרו על ידי מוצר ה-API שמכיל את ה-API.

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

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

כדי לאשר או לבטל מפתח API:

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

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

כדי לנהל מוצרי API באפליקציה, מבצעים את המשימות הבאות:

הוספה של מוצר API לאפליקציה

כדי להוסיף מוצר API לאפליקציה:

  1. ניגשים לדף האפליקציות.
  2. לוחצים בשורה של האפליקציה שרוצים לראות ולערוך.
  3. לוחצים על עריכה.
  4. מבצעים אחת מהמשימות הבאות:
    • כדי להוסיף מוצר API למפתח API חדש, לוחצים על כדי ליצור פרטי כניסה חדשים, בוחרים תאריך תפוגה ומוסיפים את מוצר ה-API למפתח ה-API.
    • כדי להוסיף מוצר API למפתח API קיים, בקטע Credential לוחצים על Add product ובוחרים את מוצר ה-API מהרשימה הנפתחת.
  5. לוחצים על שמירה.

הסרת מוצר API מאפליקציה

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

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

אפשר להוסיף מחדש מוצר שהוסר.

יצירת פרטי כניסה חדשים

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

כדי ליצור מפתח API חדש:

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

אישור או ביטול של אפליקציה

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

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

כדי לאשר או לבטל את הגישה של אפליקציה:

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

מחיקת אפליקציה

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

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

כדי למחוק אפליקציה:

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

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

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

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

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