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

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

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

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

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

Classic Edge (ענן פרטי)

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

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

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

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

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

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

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

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

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

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

    		 כן
    כתובת אתר של קריאה חוזרת (callback) בדרך כלל מציינים את כתובת ה-URL של אפליקציה שמוגדרת לקבל קוד הרשאה בשם אפליקציית הלקוח. הערך הזה לא נדרש בכל מוצרי ה-API. לא
    הערות הערות תיאוריות לגבי האפליקציה. לא
  4. מציינים את פרטי הכניסה, כולל תאריך התפוגה והסטטוס של מפתח ה-API ואת מוצרי ה-API המשויכים.
    בקטע Credentials (פרטי כניסה), לוחצים על ומזינים את הפרטים הבאים:
    שדה תיאור
    תפוגה מגדירים את משך התוקף או את תאריך התפוגה, או מגדירים שמפתח ה-API לא יפוג לעולם, ולוחצים על OK.
    מוצרים משייכים מוצר 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 וסודות:

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

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

בדרך כלל, קריאות API לשרתים proxy של API מחייבות מפתח 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 ספציפי, בוחרים באפשרות Approved (אושר) או Revoked (בוטל) בעמודה Status (סטטוס) של מוצר ה-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. בקטע Credentials (פרטי כניסה), לוחצים על .
  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:

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