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

אתם צופים במסמכי התיעוד של Apigee Edge.
כדאי לעיין במסמכי התיעוד של Apigee X. מידע

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

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

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

אתם יכולים להוסיף בקלות אימות OAuth ל-API כשאתם יוצרים שרת proxy חדש של 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. בסרגל הניווט העליון, בוחרים באפשרות ממשקי API > שרתי proxy ל-API.
  3. לוחצים על + API Proxy (שרת proxy ל-API).
  4. משתמשים באשף ליצירת שרת proxy כדי ליצור שרת proxy הפוך. מידע נוסף זמין במאמר בנושא יצירת שרת proxy פשוט של API.
  5. בדף Security (אבטחה) של אשף ההגדרה, לוחצים על לחצן הבחירה לצד OAuth v2.0.

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

שימו לב: תיבת הסימון Publish API Product הופכת לזמינה לבחירה ומסומנת באופן אוטומטי. מסמנים את התיבה הזו אם רוצים ליצור מוצר באופן אוטומטי כשיוצרים את proxy ל-API החדש. המוצר שנוצר אוטומטית יקושר לפרוקסי החדש של ה-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 עם כותרת Authorization וטוקן Bearer, כמו בדוגמה הבאה:

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

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