הגדרת התראה לגבי מגבלת קצב בתוכנית התעריפים

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

אתם יכולים לשלוח למפתחים התראה באימייל כשהם מתקרבים למגבלה מסוימת או מגיעים אליה במסגרת תוכנית של כרטיס תעריפים עם הנחות על נפח או חבילה שהם רכשו. לדוגמה, אם מפתחים רוכשים תוכנית עם נפח שימוש מוגדר מראש של 1,000 קריאות, אתם יכולים לשלוח להם התראה כשהם מגיעים ל-800 קריאות (80% מהשימוש) או כשהם מוציאים 500 $על קריאות ל-API.

כדי להגדיר התראה על הגעה למגבלה בתוכנית תמחור באמצעות ה-API, מבצעים את השלבים הבאים:

1. התאמה אישית של תבנית ההתראה שתשמש להודעה למפתח.
2. הגדרת התנאי והפעולה של ההתראה.

התאמה אישית של תבנית ההתראה

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

$ curl -H "Content-Type: application/json " -X POST -d \    
'{
    "name": "RATE_PLAN_LIMIT_TEMPLATE",
    "subject": "Nearing your rate plan limit",
    "htmlImage": "<p>Hi ${developer.name} - Wanted to let you know that you have used 800 API calls from your ${ratePlan.displayName} rate plan, which started on ${ratePlan.startDate} under the ${ratePlan.monetizationPackage.displayName} package and ${ratePlan.monetizationPackage.products.displayName} product. Just a friendly reminder that your API calls will be charged double after you cross 1000 calls. Thanks for using the API!</p>",
    "source": "Postman API call"
    }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/notification-email-templates" \
    -u email:password

הגדרת התנאי והפעולה של ההתראה

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

כדי להפעיל את ההתראה על מגבלה של תוכנית מחירים, מגדירים את המאפיינים הבאים:

• ‫RATEPLAN – סוג ההתראה לשליחה.
• ‫PUBLISHED – מגדירים את המאפיין הזה לערך TRUE כדי להפעיל התראות על תוכניות תמחור שפורסמו.

לאחר מכן מציינים אחד מהמאפיינים הבאים:

• ‫Transactions – מספר העסקאות. לדוגמה, לשלוח התראה למפתחים כשהם מגיעים ל-800 עסקאות. הערך חייב להיות מספר שלם, ומותר להשתמש רק באופרטורים > ו-=.
• ‫FeeExposure – סכום הדולרים או הנקודות שנצברו בעסקאות. הערך חייב להיות מספר שלם, ומותר להשתמש רק באופרטורים > ו-=. FeeExposure לא כולל סכומים של עמלות הגדרה, עמלות חוזרות או עמלות סיום. לדוגמה, קבלת הודעה למפתחים כשהעלות של עסקאות ה-API שלהם מגיעה ל-500$. החישובים של FeeExposure משתנים בהתאם לשיעור המס.

המטען הייעודי (payload) הבא מפעיל התראה באימייל כשהמספר של העסקאות מגיע ל-800:

$ curl -H "Content-Type:application/json" -X POST -d \
    '{
    "notificationCondition": [
      {
        "attribute": "RATEPLAN",
        "value": "{RATE_PLAN_ID}"
      },
      {
        "attribute": "PUBLISHED",
        "value": "TRUE"
      },
      {
        "attribute": "Transactions",
        "value": "= 800"
      }     
    ],
   "actions": [{
          "actionAttribute": "DEV_ID",
          "value": "ANY",
          "templateId": "{EMAIL_TEMPLATE_ID}"
        }]
  }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-conditions" \
    -u email:password