OAuth 2.0: הגדרה של שרת proxy חדש ל-API

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

אם אתם משתמשים בגרסת Apigee Cloud של Edge, תראו ששרת proxy שנקרא oauth כלול בארגון כברירת מחדל. שרת ה-proxy הזה מספק שתי נקודות קצה לדוגמה ליצירת אסימוני גישה ורענון. למידע נוסף על נקודות קצה של אסימון OAuth, קראו את המאמר הסבר על נקודות קצה של OAuth.

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

הוספת OAuth 2.0 לשרת proxy חדש ל-API

כשיוצרים שרת proxy חדש ל-API, אפשר להוסיף בקלות אימות OAuth לממשק API.

Edge

כך מוסיפים אימות OAuth ל-API באמצעות ממשק המשתמש של Edge:

  1. נכנסים לאתר apigee.com/edge.
  2. בסרגל הניווט הימני, בוחרים באפשרות פיתוח > שרתי proxy של API.
  3. לוחצים על + שרת Proxy.
  4. השתמש באשף יצירת שרת proxy כדי ליצור שרת proxy הפוך. למידע נוסף, ראו בניית שרת proxy פשוט ל-API.
  5. בדף Common policies של האשף, לוחצים על לחצן הבחירה שליד OAuth v2.0.

Classic Edge (ענן פרטי)

כדי להוסיף אימות OAuth ל-API באמצעות ממשק המשתמש הקלאסי של Edge:

  1. נכנסים אל http://ms-ip:9000. ms-ip הוא כתובת ה-IP או שם ה-DNS של הצומת של שרת הניהול.
  2. בסרגל הניווט העליון, בוחרים באפשרות APIs > API Proxies (ממשקי API > ממשקי API).
  3. לוחצים על + API Proxy.
  4. השתמש באשף יצירת שרת proxy כדי ליצור שרת proxy הפוך. למידע נוסף, ראו בניית שרת proxy פשוט ל-API.
  5. בדף אבטחה באשף, לוחצים על לחצן הבחירה שליד OAuth v2.0.

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

שימו לב שתיבת הסימון Publish API Product זמינה לבחירה ומסומנת באופן אוטומטי. צריך לסמן את האפשרות הזו אם ברצונך ליצור מוצר באופן אוטומטי כשבונים את שרת ה-proxy החדש ל-API. המוצר שנוצר באופן אוטומטי ייווצר עם שיוך לשרת ה-proxy החדש של ה-API. אם יש לך מוצר קיים שאליו ברצונך לשייך את ה-API החדש, צריך להסיר את תיבת הסימון הזו כדי לא ליצור מוצר מיותר. מידע נוסף על מוצרים זמין במאמר מהו מוצר API?

עבודה עם שרת proxy של OAuth המוגדר כברירת מחדל

שרת ה-proxy של oauth חושף את ה-URI הבא של נקודת הקצה:

/oauth/client_credential/accesstoken

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

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

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 עם כותרת Authorization ואסימון למוכ"ז, באופן הבא:

curl -H "Authorization: Bearer <your access token>" http://myorg-myenv.apigee.net/myapi

למידע נוסף, ראו אימות של אסימוני גישה.