חלק 2: יצירה ובדיקה של מפתח API

כרגע מוצג התיעוד של Apigee Edge.
כניסה למסמכי התיעוד של Apigee X. מידע

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

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

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

1. יצירת מוצרי ה-API ב-Apigee Edge שמרכזים את ממשקי ה-API שלכם.
2. רישום מפתחי אפליקציות ב-Edge. רק מפתח אפליקציה רשום יכול לרשום אפליקציה.
3. מפתחים רושמים אפליקציות ב-Edge כדי לגשת למוצרי API. בתגובה, המפתח מקבל מפתח API. עכשיו למפתח יש מפתח API, והוא יכול לשלוח בקשות לממשקי ה-API שלך.

למידע נוסף, ראו מבוא לפרסום.

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

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

דרישות מוקדמות במדריך הזה

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

שלב 1: יצירת מוצר של API

1. בממשק המשתמש לניהול, לוחצים על הכרטיסייה Publish (פרסום) ואז על Products (מוצרים).
2. לוחצים על (+) מוצר.
3. מזינים או בוחרים את הפרטים הבאים בשדות של תיבת הדו-שיח 'הוספת מוצר':

   שדה	Value
   שם	מוצר API בחינם
   השם המוצג	מוצר API בחינם
   תיאור	מוצר API בחינם
   סביבה	test
   גישה	פנימי בלבד
   סוג אישור המפתח	אוטומטי (מפתח ה-API מאושר באופן אוטומטי אחרי שהוא נוצר)
   מכסה	10 בקשות בשעה (מספר הבקשות מוגבל ל-10 בשעה)
   היקפי OAuth מותרים	להשאיר ריק

   תיבת הדו-שיח המלאה אמורה להיראות כך:

   

4. בקטע 'משאבים' בוחרים באחת מהאפשרויות הבאות:
   • שרת proxy ל-API: weatherapikey
   • גרסה: 1
   • הנתיב של המשאב: /forecastrss**
     
     השדה Resource Path (נתיב המשאב) מציין את מזהי ה-URI של המשאבים שהמוצר מאפשר לאפליקציה לגשת אליהם. בדוגמה הזו, אפליקציה יכולה לגשת למשאב /forecastrss בשרת ה-proxy של weatherapikey רק דרך מוצר ה-API הזה. אסור לנסות להשתמש במוצר ה-API הזה כדי לגשת למשאב אחר בשרת ה-proxy של weatherapiproxy או בכל שרת proxy אחר.
     
     בנתיב המשאב אפשר להשתמש בתווים כלליים לחיפוש. התו הכללי לחיפוש "/**" מציין שכל מזהי ה-URI נכללים, כלומר משאב בצורה /forecastrss/foo/bar. התו הכללי לחיפוש "/" מציין שנכללו רק מזהי URI ברמה אחת למטה. מידע נוסף זמין במאמר יצירת מוצרי API.
     
     שימו לב שברשימה הנפתחת נתיב המשאב מוצגים כל התהליכים המותנים שהוגדרו בשרת proxy של ה-API שצוין. בתהליך המותנה של שרת proxy ל-API, מוגדרים הלוגיקה או שלבי העיבוד שמשויכים לנתיב המשאב. מוצר API קובע את הגישה לנתיבי המשאבים האלה.
     
5. לוחצים על ייבוא משאב. המערכת מוסיפה את נתיב המשאב, ושרת ה-API של weatherapikey מתווסף באופן אוטומטי לקטע API proxys for Product.
6. לוחצים על שמירה. המוצר החדש מופיע בדף המוצרים.

מידע נוסף:

• יצירת מוצרי API

שלב 2: רישום מפתח

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

1. בממשק המשתמש של הניהול, לוחצים על הכרטיסייה Publish (פרסום) ואז על Developers (מפתחים).
2. לוחצים על (+) מפתח.
3. בתיבת הדו-שיח 'מפתח חדש', מזינים את הערכים הבאים:
   • First Name (שם פרטי): Jane
   • Last Name: מדריך
   • כתובת אימייל: janetutorial@example.com
   • שם משתמש: jtutorial
4. לוחצים על שמירה. המפתח החדש מופיע ברשימת המפתחים בדף המפתחים.

מידע נוסף:

• ניהול מפתחי אפליקציות

שלב 3: רישום האפליקציה

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

1. בממשק המשתמש של פלטפורמת ה-API, לוחצים על הכרטיסייה Publish (פרסום) ולאחר מכן על Developer Apps (אפליקציות למפתחים).
2. לוחצים על (+) אפליקציית מפתח.
3. בתיבת הדו-שיח 'הוספת אפליקציה', מזינים את הערכים הבאים:
   • שם תצוגה: אפליקציית מפתח API של מזג האוויר
   • מפתח: מדריך ג'יין (janetutorial@example.com)
   • כתובת URL לקריאה חוזרת: יש להשאיר ריק
4. כדי לשייך את האפליקציה למוצר:
   1. בקטע מוצרים, לוחצים על + מוצר.
   2. בוחרים באפשרות מוצר API חינמי.
   3. לוחצים על סימן הווי כדי לאשר את השינויים.
5. לוחצים על שמירה. האפליקציה החדשה תופיע ברשימת האפליקציות בדף 'אפליקציות למפתחים'.
6. ברשימת האפליקציות, בוחרים באפשרות Weather API Key App. הפעולה הזו תפתח את דף הפרטים של האפליקציה.
7. מאחר שבחרתם את האפשרות Key Approval Type: automatic כשיצרת את מוצר ה-API, מפתח ה-API מאושר באופן אוטומטי ותוכלו להציג אותו באופן מיידי. (אם בחרת באפשרות Approval Type: Manual (סוג אישור: ידני), עליך ללחוץ על Approve (אישור) בעמודה Actions for Free API Product כדי לאשר את מפתח ה-API.)
8. בקטע Products (מוצרים), ליד הרשומה Free API Product, לוחצים על Show בעמודות Consumer Key ו- Consumer Secret כדי להציג את המפתחות שנוצרו.
   

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

מידע נוסף:

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

שלב 4: שימוש במפתח ה-API בבקשה

כדי לוודא שהמדיניות verificationAPIKey פועלת בצורה תקינה, צריך לבדוק אותה על ידי קריאה לשרת ה-proxy של ה-API באמצעות מפתח API תקין. אפשר לבקש את שרת ה-API של ה-API בדפדפן, מדף המעקב של שרת ה-API של שרת ה-proxy, מ-Apigee Console, או באמצעות cURL. כתובת ה-URL לבקשה מופיעה בצורה הבאה:

http://{org-name}-test.apigee.net/v1/weatherapikey/forecastrss?w=12797282&apikey=IEYRtW2cb7A5Gs54A1wKElECBL65GVls

מחליפים את שם הארגון ב-Apigee את {org-name} ואת הערך הנכון של apikey.

מחפשים את התוכן הבא בתשובה:

<rss xmlns:yweather="http://xml.weather.yahoo.com/ns/rss/1.0" xmlns:geo="http://www.w3.org/2003/01/geo/wgs84_pos#" version="2.0"> 
<channel> <title>Yahoo! Weather - Palo Alto, CA</title> 
<link>http://us.rd.yahoo.com/dailynews/rss/weather/Palo_Alto__CA/*http://weather.yahoo.com/forecast/USCA1093_f.html</link> 
<description>Yahoo! Weather for Palo Alto, CA</description> <language>en-us</language>

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

{"fault":{"faultstring":"Failed to resolve API Key variable null","detail":{"errorcode":"steps.oauth.v2.FailedToResolveAPIKey"}}}

שלב 5: לאן השלב הבא?

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

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