רישום אפליקציות וניהול מפתחות 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. לוחצים על + אפליקציה.
3. מציינים את פרטי האפליקציה:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

הצגת מפתח וסוד של API

כדי להציג מפתח API וסוד:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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