אתה צופה בתיעוד של Apigee Edge.
הצג תיעוד של Apigee X.
אם משתמשים בגרסה של Edge ב-Apigee Cloud, שרת ה-proxy בשם oauth כלול בארגון שלכם כברירת מחדל. שרת ה-proxy הזה מספק שתי נקודות קצה לדוגמה ליצירת אסימוני גישה ורענון. מידע נוסף לגבי נקודות קצה של אסימוני OAuth זמין במאמר הסבר על נקודות קצה (endpoint) ב-OAuth.
הסוג של הענקת פרטי הכניסה של הלקוח מגדיר נוהל להקצאת אסימוני גישה בתמורה לפרטי הכניסה של האפליקציה. פרטי הכניסה של האפליקציה הם זוג המפתחות והסודות של הצרכנים, ש-Apigee Edge מנפיק לכל אפליקציה הרשומה בארגון. לפרטים נוספים אפשר לעיין במאמר הטמעה של סוג ההרשאה לקוד ההרשאה.
הוספה של OAuth 2.0 לשרת proxy חדש של API
אפשר להוסיף בקלות אימות OAuth ל-API בזמן יצירת שרת proxy חדש ל-API.
Edge
כדי להוסיף אימות OAuth לממשק API באמצעות ממשק המשתמש של Edge:
- נכנסים אל apigee.com/edge.
- בוחרים באפשרות פיתוח > שרתי proxy של API בסרגל הניווט הימני.
- לוחצים על + שרת Proxy
- כדי ליצור שרת proxy הפוך, צריך להשתמש באשף היצירה של שרת ה-proxy. למידע נוסף, ראו יצירה של שרת proxy פשוט ל-API.
- בדף Policy policies באשף, לוחצים על לחצן הבחירה שלצד OAuth v2.0.
Classic Edge (ענן פרטי)
כדי להוסיף אימות OAuth לממשק API באמצעות ממשק המשתמש של הגרסה הקלאסית של Edge:
- כניסה אל
http://ms-ip:9000
, כאשר ms-ip הוא כתובת ה-IP או שם ה-DNS של צומת שרת הניהול. - בוחרים באפשרות APIs > API Proxies בסרגל הניווט העליון.
- לוחצים על + API Proxy
- כדי ליצור שרת proxy הפוך, צריך להשתמש באשף היצירה של שרת ה-proxy. למידע נוסף, ראו יצירה של שרת proxy פשוט ל-API.
- בדף Security באשף, לוחצים על לחצן הבחירה שלצד OAuth v2.0.
כשבוחרים באפשרות הזו, מצרפים שני כללי מדיניות אל שרת ה-API של שרת ה-API החדש שנוצר, אחד כדי לאמת את אסימוני הגישה והשני כדי להסיר את אסימון הגישה אחרי האימות.
שימו לב שתיבת הסימון Publish API Product הופכת לבחירה ולבחירה באופן אוטומטי. יש לסמן את האפשרות הזו אם ברצונך ליצור מוצר באופן אוטומטי במהלך היצירה של שרת ה-API החדש של ה-API. המוצר שנוצר באופן אוטומטי ישויך ל-proxy החדש של ה-API. אם יש לך מוצר קיים שאליו ברצונך לשייך את ממשק ה-API החדש הזה, יש לבטל את הסימון בתיבת הסימון הזו כדי לא ליצור מוצר מיותר. מידע על מוצרים זמין במאמר מהו מוצר API?
עבודה עם שרת ה-proxy המוגדר כברירת מחדל עבור OAuth
שרת ה-proxy של OAuth חושף את ה-URI הבא של נקודת הקצה:
/oauth/client_credential/accesstoken
פרסום ה-URI הזה למפתחים שצריכים לקבל אסימוני גישה. מפתחי האפליקציות מגדירים את האפליקציות שלהם כך שיקראו לנקודת הקצה הזו, ומציגים את זוג המפתחות והסודות של הצרכנים כדי לקבל אסימוני גישה.
נקודת הקצה של אסימון פרטי הכניסה שמוגדרת כברירת המחדל של הלקוח נחשפה ברשת בכתובת ה-URL הבאה:
https://{org_name}-{env_name}.apigee.net/oauth/client_credential/accesstoken
לדוגמה, אם שם הארגון הוא "apimakers", כתובת ה-URL תהיה:
https://apimakers-test.apigee.net/oauth/client_credential/accesstoken
זוהי כתובת ה-URL שאליה המפתחים קוראים כדי לקבל אסימוני גישה.
קריאה ל-API
כשמקבלים אסימון גישה, אפשר להפעיל את ה-API באמצעות כותרת הרשאה ו אסימון נושא, באופן הבא:
curl -H "Authorization: Bearer <your access token>"
http://myorg-myenv.apigee.net/myapi
למידע נוסף, ראו אימות של אסימוני גישה.