אכיפת מגבלות מונטיזציה בשרתי proxy של API

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

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

בדף הזה מוסבר איך לאכוף מגבלות מונטיזציה על ידי צירוף כללי מדיניות לשרתי proxy ל-API במוצר API עם מונטיזציה.

הוספת מדיניות אימות

ב-Apigee monetization נעשה שימוש במדיניות VerifyAPIKey או בפעולה VerifyAccessToken של מדיניות OAuth2 כדי לבדוק אם בקשה נכנסת מתאימה למונטיזציה, על ידי בדיקה אם יש תוכנית תמחור פעילה שפורסמה.

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

מידע נוסף:

אכיפת מינויים על מוצרי API

מצרפים את MonetizationLimitsCheck policy לשרתי proxy ל-API כדי לאכוף מינויים על מוצר ה-API לפי מפתח או AppGroup:

  • אם לא קיימת תוכנית תמחור פעילה למוצר ה-API שאוחזר במהלך הביצוע של קריאת ה-proxy, המוצר נחשב כלא מניב הכנסות, המדיניות MonetizationLimitsCheck לא מאחזרת נתונים נוספים, ולמדיניות אין השפעה.
  • אם נמצא תוכנית תמחור אבל לא נמצא מינוי למפתח ה-API או ל-AppGroup, המדיניות MonetizationLimitsCheck מעלה תקלה וחוסמת את הקריאה ל-API.

כשמצרפים את מדיניות MonetizationLimitsCheck לפרוקסי ל-API, ‏ Apigee מאכלס את משתני הזרימה mint.limitscheck.* ו-mint.subscription_*, כפי שמתואר במאמר ניפוי באגים במדיניות MonetizationLimitsCheck ובמאמר בנושא משתנה הזרימה mint.

למידע נוסף:

אכיפת מכסות מונטיזציה בשרתי proxy ל-API

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

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

עורכים את מדיניות המכסות כדי להפעיל את הרכיב <UseQuotaConfigInAPIProduct>, וכך להשתמש בהגדרת המכסות שמוגדרת ברמת מוצר ה-API.

לדוגמה:

<Quota continueOnError="false" enabled="true" name="impose-quota">
    <DisplayName>Impose Quota</DisplayName>
    <UseQuotaConfigInAPIProduct stepName="verify-api-key">
        <DefaultConfig>
            <Allow>10000</Allow>
            <Interval>1</Interval>
            <TimeUnit>week</TimeUnit>
        </DefaultConfig>
    </UseQuotaConfigInAPIProduct>
    <Distributed>true</Distributed>
    <Synchronous>true</Synchronous>
    <StartTime>2021-01-01 12:00:00</StartTime>
</Quota>

כשמצרפים את מדיניות הקצאת נפח האחסון ל-proxy ל-API, משתני הזרימה ratelimit.* מאוכלסים, כפי שמתואר במאמר Debugging the Quota policy ובמאמר בנושא flow variables של מדיניות הקצאת נפח האחסון.

למידע נוסף: