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

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

מבוא

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

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

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

יש תמיכה בתוכניות תעריפים עם מאפיינים מותאמים אישית:

• מחירון עם מאפיין מותאם אישית
• התראה שניתנת להתאמה עם מאפיין מותאם אישית

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

הסבר על החישובים של מאפיינים מותאמים אישית

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

איפה תוכנית התמחור והתשלומים מקבלת את ערך של מאפיין מותאם אישית

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

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

הנה התהליך הכללי:

1. להגדיר את המאפיינים המותאמים אישית כאשר מוסיפים מוצר API.
2. צריך ליצור חבילת מוצרים של API שמכילה את המוצר.
   במדיניות תיעוד העסקאות של חבילת המוצרים של ה-API, מוסיפים את המאפיינים המותאמים אישית שיהיו שמשמשים להגדרת תוכניות תעריפים.
3. יצירת תוכנית תעריפים מסוג מחירון או התראה שניתן לשנות לחבילת המוצרים של ה-API ולציין פרמטר של דירוג מותאם אישית.

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

איך ליצור את המאפיין המותאם אישית ערך המאפיין בהודעה

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

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

בכל בקשה לצ'אט, יש משתנה מסוג client.received.content.length מכיל את מספר הבייטים במטען הייעודי (Payload) של הבקשה. באמצעות צירוף של מדיניות הקצאת הודעות תגובה של נקודת קצה (endpoint) דרך שרת Proxy, אפשר ליצור כותרת תגובה בשם messageSize מכיל את ערך האורך:

<AssignMessage async="false" continueOnError="false" enabled="true" name="Assign-Message-1">
    <DisplayName>Assign Message 1</DisplayName>
    <Set>
        <Headers>
          <Header name="messageSize">{client.received.content.length}</Header> 
        </Headers>  
    </Set>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
    <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

הוספת ערך של מאפיין מותאם אישית של אפליקציה לכותרת

באותו אופן, אנחנו יכולים ליצור כותרת עם הערך של מאפיין מותאם אישית באפליקציה. למשל, אם מוסיפים מאפיין מותאם אישית בשם apprating לכל מפתח באופן הבא:

כשמשתמשים במדיניות לאימות מפתח API (שנדרשת למונטיזציה), הערך הזה הוא מאוחסן במשתנה שנקרא verifyapikey.{policy_name}.apprating. שימוש בהקצאה באמצעות מדיניות ההודעות שמצורפת לתשובה של נקודת הקצה (endpoint) של שרת ה-proxy, אפשר ליצור כותרת שנקראת apprating שמכיל את הערך apprating של האפליקציה:

<AssignMessage async="false" continueOnError="false" enabled="true" name="Assign-Message-1">
    <DisplayName>Assign Message 1</DisplayName>
    <Set>
        <Headers>
          <Header name="apprating">{verifyapikey.Verify-API-Key-1.apprating}</Header> 
        </Headers>  
    </Set>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
    <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

הגדרת תוכנית התעריפים

פרט להגדרת המאפיין המותאם אישית שמתואר למעלה, תוכנית התעריפים מוגדרת באותו אופן כרגיל (בתוכניות תעריפים ללא מאפיינים מותאמים אישית), אבל חייבים לפעול בהתאם הדרישות הבאות.

הגדרת תוכנית מחירון עם מאפיין מותאם אישית דרך ממשק המשתמש

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

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

ציון הפרטים של תוכנית תעריפים עם מאפיינים מותאמים אישית באמצעות ה-API

עליכם לפעול לפי השלבים המוקדמים הבאים:

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

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

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

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

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

$ curl -H "Content-Type:application/json" -X POST -d \
'{
   "name": "Custom attribute-based rate card plan",
   "developer":null,
   "developerCategory":null,
   "currency": {
     "id" : "usd"
     },     
   "description": "Custom attribute-based rate card plan",
   "displayName" : "Custom attribute-based rate card plan",
   "frequencyDuration": "1",
   "frequencyDurationType": "MONTH",
   "earlyTerminationFee": "10",
   "monetizationPackage": {
      "id": "location"
        },
      "organization": {
       "id": "{org_name}"
      },    
   "paymentDueDays": "30",
   "prorate": "false",
   "published": "false",     
   "ratePlanDetails":[
      {
        "currency":{
           "id":"usd"
        },
      "duration":1,
      "durationType":"MONTH",
      "meteringType":"VOLUME",
      "paymentDueDays":"30",
      "ratingParameter":"messageSize",
      "ratingParameterUnit":"MB",
      "organization":{
         "id":"{org_name}"
      },
      "ratePlanRates":[
         {
           "rate":0.15,
           "startUnit":0,
           "type":"RATECARD",
           "endUnit":1000
         },
         {
           "rate":0.1,
           "startUnit":1000,
           "type":"RATECARD",
           "endUnit":null
         }
      ],
      "freemiumUnit":0,
      "freemiumDuration":0,
      "freemiumDurationType":"MONTH",
      "type":"RATECARD",
      "customPaymentTerm":false
      }
    ],
    "freemiumUnit":0,
    "freemiumDuration":0,
    "freemiumDurationType":"MONTH",
    "contractDuration":"1",
    "contractDurationType":"YEAR", 
    "recurringStartUnit": 1,
    "recurringType": "CALENDAR",
    "recurringFee": "10",
    "setUpFee": "10",
    "startDate": "2013-09-15 00:00:00",
    "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

יצירת ההתראה שניתנת להתאמה עם תוכנית תעריפים של מאפיינים מותאמים אישית, שמבוססת על מאפיין מותאם אישית בשם messageSize (ראו את הפריט במודגש).

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "AdjustableNotification",
     "displayName": "Custom attribute-based adjustable notification plan",
     "description": "Custom attribute-based 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": "messageSize",
           "ratingParameterUnit": "MB",
           "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