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

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

אפשר להודיע למפתחים באימייל כשהם יתקרבו לתוכנית, או יגיעו למגבלה מסוימת של תוכנית עם מכסת נפח אחסון או חבילה שהם רכשו. לדוגמה, אם מפתחים רוכשים תוכנית עם 1,000 קריאות בחבילה, עם 1,000 קריאות בחבילה, אפשר להודיע להם כשהם מגיעים ל-800 קריאות (80% שימוש), או כשהם הוציאו 2,000 ש"ח על קריאות ל-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 משתנים בהתאם לשיעור המס.

המטען הייעודי הבא מפעיל התראה באימייל כשמספר הטרנזקציות מגיע ל-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