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

הדף הזה רלוונטי ל-Apigee ול-Apigee Hybrid.

לעיון במסמכי התיעוד של Apigee Edge

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

הוספת OAuth v2.0 ל-proxy ל-API חדש

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

כדי להוסיף אימות OAuth ל-API:

  1. במסוף Google Cloud , נכנסים לדף Apigee > Proxy development > API proxies.

    מעבר לשרתי proxy ל-API

  2. בוחרים את הארגון שלכם מבורר הפרויקטים בחלונית Google Cloud . שם הארגון זהה לשם הפרויקט ב- Google Cloud .
  3. בחלונית API Proxies (שרתי proxy של API), לוחצים על + Create (יצירה).
  4. בחלונית Create a proxy (יצירת שרת proxy), בקטע Proxy template (תבנית שרת proxy), בוחרים באפשרות Reverse proxy (most common) (שרת proxy הפוך (הנפוץ ביותר)).
  5. מגדירים את ה-Proxy עם הפרטים הבאים:
    שם ערך
    שם שרת ה-Proxy helloworld_oauth2
    נתיב בסיסי

    /hellooauth2

    נתיב הבסיס של הפרויקט הוא חלק מכתובת ה-URL שמשמשת לשליחת בקשות לשרת ה-proxy של ה-API.
    תיאור hello world protected by OAuth v2.0
    יעד (API קיים)

    https://mocktarget.apigee.net/ip

    ההגדרה הזו מגדירה את כתובת ה-URL של היעד שאליו Apigee שולחת בקשה ל-proxy ל-API. היעד הזה מחזיר רק תגובה פשוטה: Hello, Guest!.
  6. לוחצים על הבא.
  7. פריסה (אופציונלי):
    • סביבות פריסה: אופציונלי. משתמשים בתיבות הסימון כדי לבחור סביבה אחת או יותר שבהן רוצים לפרוס את ה-proxy. אם אתם לא רוצים לפרוס את ה-proxy בשלב הזה, צריך להשאיר את השדה Deployment environments ריק. תמיד אפשר לפרוס את ה-proxy מאוחר יותר.
    • חשבון שירות: אופציונלי. מצרפים חשבון שירות לפריסה כדי לאפשר לשרת ה-proxy לגשת לשירותים, כמו שמצוין בתפקיד ובהרשאות של חשבון השירות. Google Cloud
  8. לוחצים על יצירה.
  9. בחלונית Proxy summary (סיכום ה-proxy) של ה-proxy‏ helloworld_apikey, לוחצים על הכרטיסייה Develop (פיתוח).
  10. בתפריט Policies (מדיניות), לוחצים על Add policy (הוספת מדיניות).
  11. בחלונית Create policy, בקטע Security, בוחרים באפשרות Verify API Key.
  12. בחלונית Verify API Key (אימות מפתח API), ממלאים את השדות הנדרשים בקטעים Name (שם) ו-Display name (שם לתצוגה) באמצעות הערכים הבאים:
    • שם: מזינים שם למדיניות. לדוגמה, VerifyAPIKey.
    • השם המוצג: מזינים את שם המדיניות לשימוש בממשק המשתמש. לדוגמה, Verify API Key.
  13. לוחצים על יצירה.
  14. לוחצים על כדי להוסיף עוד מדיניות.
  15. בחלונית יצירת מדיניות, בקטע גישור, בוחרים באפשרות הקצאת הודעה.
  16. בחלונית Assign Message (הקצאת הודעה), ממלאים את שדות החובה בקטעים Name (שם) ו-Display name (שם לתצוגה) באמצעות הערכים הבאים:
    • שם: מזינים שם למדיניות. לדוגמה, AssignMessage.
    • השם המוצג: מזינים את שם המדיניות לשימוש בממשק המשתמש. לדוגמה, Assign Message.
  17. לוחצים על יצירה.

  18. מעדכנים את התוכן של המדיניות הקצאת הודעה כך:

    
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AssignMessage async="false" continueOnError="false" enabled="true" name="remove-header-authorization">
    <DisplayName>Remove Header Authorization</DisplayName>
    <Remove>
        <Headers>
            <Header name="Authorization"/>
        </Headers>
    </Remove>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
    <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>
  19. מוסיפים את כללי המדיניות VerifyApiKey וRemove Header Authorization.
    1. בתפריט Proxy endpoints (נקודות קצה של שרת proxy), לוחצים על Preflow (זרימת נתונים לפני העיבוד).
    2. בחלונית Request של כלי העריכה החזותי, לוחצים על Add policy step.
    3. בחלונית Add policy step (הוספת שלב מדיניות), בוחרים באפשרות Verify API Key (אימות מפתח API).
    4. לוחצים על הוספה.
    5. בחלונית Request של כלי העריכה החזותי, לוחצים על Add policy step.
    6. בחלונית Add policy step, בוחרים באפשרות Remove Header Authorization.
    7. לוחצים על הוספה.
  20. לוחצים על Save.