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

אתם צופים במסמכי התיעוד של Apigee Edge.
כדאי לעיין במסמכי התיעוד של Apigee X. מידע

מבוא

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

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

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

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

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

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

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

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

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

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

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

הנה תיאור כללי של התהליך:

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

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

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

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

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

בכל הזמנה לצ'אט יש משתנה client.received.content.length שמכיל את מספר הבייטים במטען הייעודי (payload) של הבקשה. אם נצרף מדיניות של הקצאת הודעה לתגובה של נקודת הקצה של ה-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 בכל אפליקציה של מפתח, כך:

כשמשתמשים במדיניות Verify API Key (שנדרשת למונטיזציה), הערך הזה מאוחסן במשתנה שנקרא verifyapikey.{policy_name}.apprating. באמצעות מדיניות ההודעות Assign שצורפה לתגובה של נקודת הקצה של ה-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