הגדרה של תוכנית התראות שניתנת להתאמה

מוצג המסמך של Apigee Edge.
עוברים אל מסמכי תיעוד של Apigee X. מידע

מבוא

בתוכנית התראות שניתנת להתאמה, ספק ה-API יכול לשנות את מספר היעד של העסקאות של כל מפתח אפליקציה. אפשר להגדיר אם ומתי ההתראות יישלחו על סמך כשמגיע אחוז ממספר היעד, כמו 90%, 100% או 150%. פרטים נוספים העסקאות לא חסומות לאחר הגעה למספר היעד.

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

הגדרת תוכניות התראה הניתנות להתאמה, כפי שמתואר בהמשך.

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

מציינים את הפרטים של תוכנית ההתראות שאפשר לשנות בנכס ratePlanDetails בגוף הבקשה בבקשת POST כדי /organizations/{org_name}/monetization-packages/{package_id}/rate-plans.

כדי לציין תוכנית התראות שניתנת להתאמה, מציינים את הערכים הבאים ב ratePlanDetails של גוף הבקשה:

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

לדוגמה, בהמשך מוגדרת תוכנית התראות ניתנת להתאמה על בסיס צבירת נתונים מוגדר לחודש אחד.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "AdjustableNotification",
     "displayName": "Adjustable notification plan",
     "description": "Adjustable notification plan",
     "published": "true",  
     "organization": {
      "id": "myorg"
     },
     "startDate": "2016-04-15 00:00:00",
     "type": "STANDARD",
     "monetizationPackage": {
        "id": "p1",
        "name": "test"
     },
     "currency": {
        "id" : "usd",
        "name" : "USD"
     },
     "ratePlanDetails": [
        {
           "type": "USAGE_TARGET",
           "meteringType": "DEV_SPECIFIC",
           "duration": 1,
           "durationType": "MONTH",
           "ratingParameter": "VOLUME",
           "organization": {
             "id": "myorg"
           },
           "currency": {
             "id": "usd",
             "name": "USD"
           }
        }
     ]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/p1/rate-plans"  \
-u email:password

הגדרת היעד מספר העסקאות שבוצעו לכל מפתח אפליקציה באמצעות ה-API

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

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

כשמאשרים את תוכנית התעריפים, צריך לציין את מספר היעד של העסקאות הנכס quotaTarget בגוף הבקשה בבקשת POST אל משאב /organizations/{org_name}/developers/{developer_id}/developer-rateplans. צריך להגדיר את quotaTarget למספר שלם חיובי או 0 כדי להשבית את ההתראות מהאפליקציה למפתחים. אם לא מציינים זאת, ערך ברירת המחדל של quotaTarget הוא 0.

לדוגמה, הבקשה הבאה מגדירה את מספר היעד של העסקאות ל-4000 כשהאפליקציה המפתח מקבל את תוכנית ההתראות הניתנת להתאמה.

$ curl -H "Content-Type:application/json" -X POST -d \
'{ 
   "developer":{
     "id":"dev@mycompany.org"
   },
   "ratePlan":{
     "id":"p1_adjustable-notification-plan"
   },
   "startDate": "2016-03-24 00:00:00",
   "quotaTarget": 4000,
   "suppressWarning": false
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans" \
-u email:password

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

כדי להגדיר את מספר היעד של העסקאות, אפשר לעדכן את תוכנית התעריפים הקבילה ולציין המאפיין quotaTarget בגוף הבקשה בבקשת PUT /organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id} משאב. כדי להשבית, צריך להגדיר את quotaTarget למספר שלם חיובי או 0 התראות למפתח האפליקציה. אם לא מציינים זאת, ערך ברירת המחדל של quotaTarget הוא 0.

השדה {developer_rateplan_id} מוחזר בתגובה אחרי שאתם מאשרים את תוכנית התמחור והתשלומים שפורסמה.

לדוגמה:

{
  "created": "2016-03-31 18:59:54",
  "developer": {
    ...
  },
  "id": "b1c600b8-f871-496d-8173-12b9950d6ab1",
  "quotaTarget": 3000,
  "ratePlan": {
    ...
  },
  "startDate": "2016-03-31 00:00:00",
  "updated": "2016-03-31 18:59:54",
  "waiveTerminationCharge": false
}

לחלופין, אפשר לקבל את {developer-rateplan-id} עבור התעריף למפתחים על ידי שליחת בקשת GET /organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans, כאשר {developer_id} הוא כתובת האימייל של המפתח. לקבלת מידע נוסף, ראה הצגת כל תוכניות התמחור והתשלומים שאושרו על ידי מפתח.

לדוגמה:

{
  "developerRatePlan": [
    {
      "created": "2016-03-31 14:52:30",
      "developer": {
        ...
      },
      "id": "b1c600b8-f871-496d-8173-12b9950d6ab1",
      "quotaTarget": 3000,
      "ratePlan": { 
        ... 
      }, 
      "startDate": "2016-03-31 00:00:00", 
      "updated": "2016-03-31 18:59:54" 
    } 
  ], 
  "totalRecords": 1 
}
        

הבקשה הבאה מתעדכנת את מספר היעד של העסקאות ל-4,000.

$ curl -H "Content-Type:application/json" -X PUT -d \
'{ 
   "id" : "b1c600b8-f871-496d-8173-12b9950d6ab1",
   "developer":{
     "id":"dev@mycompany.com"
   },
   "ratePlan":{
     "id":"p1_adjustable-notification-plan"
   },
   "startDate": "2016-04-15 00:00:00",
   "quotaTarget": 4000,
   "suppressWarning":false
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans/b1c600b8-f871-496d-8173-12b9950d6ab1"
-u email:password