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

מוצג המסמך של 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