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

אתם צופים במסמכי התיעוד של 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.

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

$ 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