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

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

1. נכנסים לדף האפליקציות.
2. לוחצים על + App (הוספת אפליקציה).
3. מציינים את פרטי האפליקציה:

   שדה	תיאור	חובה?
   שם	שם האפליקציה. אי אפשר לשנות את השם אחרי שיוצרים את האפליקציה. השם הזה משמש לקריאות ל-API לניהול.	כן
   השם המוצג	השם המוצג של האפליקציה שמופיע בממשק הניהול של Edge ובפורטל למפתחים.	לא
   חברה/מפתח	הערה: ב-Apigee hybrid אין תמיכה באפליקציות של החברה, ולכן השדה הזה לא רלוונטי. בוחרים באפשרות חברה או מפתח ובוחרים שם של חברה או מפתח מהתפריט הנפתח. הערה: מטעמי ביצועים, לא כל החברות או המפתחים מוצגים בתפריט הנפתח. מתחילים להקליד את שם החברה, שם המפתח או כתובת האימייל בתיבת החיפוש. אפשר לעיין גם במאמר בנושא רישום מפתחי אפליקציות.	כן
   כתובת אתר של קריאה חוזרת (callback)	בדרך כלל מציינים כאן את כתובת ה-URL של אפליקציה שמיועדת לקבל קוד הרשאה מטעם אפליקציית הלקוח. הערך הזה לא נדרש לכל מוצרי ה-API.	לא
   הערות	הערות תיאוריות לגבי האפליקציה.	לא

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

בדרך כלל נדרש מפתח API כדי לשלוח קריאות ל-API לשרתי proxy של 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 מאפליקציה

הוספת מוצר 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:

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

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