ניהול תוכניות תעריפים

כרגע מוצג התיעוד של Apigee Edge.
כניסה למסמכי התיעוד של Apigee X. מידע

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

סקירת הדף 'תוכניות מחירים'

נכנסים לדף תוכניות התעריפים כמו שמתואר בהמשך.

Edge

כדי להציג תוכניות תעריפים בממשק המשתמש של Edge, צריך להיכנס לדף תוכניות התעריפים:

  1. נכנסים לאתר apigee.com/edge.
  2. בוחרים באפשרות פרסום > מונטיזציה > תוכניות תמחור בסרגל הניווט הימני.

דף תוכניות המחירים מוצג.

כפי שמודגש באיור, דף תוכניות התעריפים מאפשר:

Classic Edge (ענן פרטי)

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

  1. נכנסים אל http://ms-ip:9000. ms-ip הוא כתובת ה-IP או שם ה-DNS של הצומת של שרת הניהול.
  2. בוחרים באפשרות פרסום > חבילות בסרגל הניווט העליון.

בדף 'חבילות API' מוצגים תוכניות התעריפים שהוגדרו לכל חבילה.

דף תוכניות המחירים מאפשר לכם:

יצירת תוכנית תמחור ותשלומים

כדי ליצור תוכנית תמחור ותשלומים:

  1. נכנסים לדף 'תוכניות תמחור'.
  2. לוחצים על +תוכנית תעריפים.
  3. צריך להגדיר את השדות הבאים בחלונית העליונה:
    שדה התיאור ברירת המחדל נדרש
    שם תוכנית התמחור והתשלומים השם של תוכנית התמחור והתשלומים.

    הערה: השם חייב להיות ייחודי בחבילת מוצרים של API. לא ניתן להשתמש בשם זהה לשתי תוכניות באותה חבילת מוצרים.

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

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

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

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

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

    הערה: תוכנית התעריפים תהיה בתוקף עד סוף היום בתאריך שצוין. לדוגמה, אם רוצים שתוקף תוכנית התעריפים יפוג ב-1 בדצמבר 2018, צריך להגדיר את הערך endDate כ-30.11.2018. במקרה כזה, התוקף של תוכנית התעריפים יפוג בסוף היום ב-30 בנובמבר 2018. כל הבקשות החל מ-1 בדצמבר 2018 ייחסמו.

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

    הערה: חשוב לוודא שאתם מגדירים את כל המוצרים בחבילת המוצרים.

    		לא רלוונטי
  6. מגדירים את פרטי תוכנית התעריפים בהתאם לסוג תוכנית התעריפים שנבחר:
  7. לוחצים על אחת מהאפשרויות הבאות:
    לחצן התיאור
    שמירה כטיוטה שומרים את תוכנית התמחור והתשלומים כטיוטה.

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

    פרסום התוכנית החדשה מפרסמים את התוכנית.

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

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

עריכה של תוכנית תמחור ותשלומים

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

כדי לערוך תוכנית תעריפים:

  1. נכנסים לדף 'תוכניות תמחור'.
  2. לוחצים על השורה של תוכנית התמחור והתשלומים שרוצים לערוך.
    החלונית של תוכנית התמחור והתשלומים מוצגת.
  3. עורכים את השדות של תוכנית התעריפים, לפי הצורך.
    הערה: אחרי שאתם מפרסמים תוכנית תעריפים, אפשר לשנות את תאריך הסיום רק אם הוא עדיין לא הוגדר.
  4. לוחצים על אחת מהאפשרויות הבאות:
    לחצן התיאור
    עדכון טיוטה (טיוטות של תוכניות ליצירת תעריפים) שומרים את תוכנית התמחור והתשלומים כטיוטה.

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

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

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

מחיקה של טיוטת תוכנית תמחור ותשלומים

מוחקים את טיוטת התוכנית, אם אין בה צורך יותר.

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

כדי למחוק טיוטה של תוכנית תמחור ותשלומים:

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

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

בקטעים הבאים מוסבר איך לנהל תוכניות תעריפים באמצעות ה-API.

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

כדי ליצור תוכנית תעריפים, צריך לשלוח בקשת POST אל /organizations/{org_name}/monetization-packages/{monetizationpackage_id}/rate-plans. {monetizationpackage_id} הוא המזהה של חבילת המוצרים ב-API שעבורה יצרת את תוכנית התעריפים (המזהה מוחזר בתגובה כשיוצרים את חבילת המוצרים של ה-API).

כשיוצרים תוכנית תעריפים, צריך לציין את הפרטים הבאים בגוף הבקשה:

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

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

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

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

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

כדי ליצור תוכנית תעריפים רגילה, צריך להגדיר את המאפיין type כ-STANDARD, כפי שמוצג בדוגמה הבאה.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Simple rate plan",
     "currency": {
      "id" : "usd"
     },
     "description": "Simple rate plan",
     "displayName" : "Simple rate plan",
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },
     "published": true,
     "isPrivate" : false,
     "ratePlanDetails": [
     {
      …
     }
     ],
     "startDate": "2013-09-15",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location_package/rate-plans" \
-u email:password

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

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

לדוגמה, הקטע הבא יוצר תוכנית תמחור ותשלומים עבור המפתח של Dev Five:

...
     "type": "DEVELOPER",
       "developer" : {
        "id" : "0mkKu1PALUGfjUph",
        "legalName" : "DEV FIVE",
        "name" : "Dev Five"
      }
...

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

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

...
     "type": "DEVELOPER_CATEGORY",
       "developerCategory" : {
        "id" : "5e172299-8232-45f9-ac46-40076139f373",
        "name" : "Silver",
        "description" : "Silver category"
      }
...

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

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

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

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Multi-product rate plan",
     "currency": {
      "id" : "usd"
     },
     "description": "Multi-product rate plan",
     "displayName" : "Multi-product rate plan",
     "monetizationPackage": {
      "id": "mypackage",
      ...
     },
     "organization": {
      "id": "{org_name}",
      ...
     },
     "published": true,
     "isPrivate" : false,
     "ratePlanDetails": [
     {
        "ratePlanRates":[{
            "revshare":0,
            "startUnit":0,
            "type":"REVSHARE",
            "endUnit":null
        }],
       "revenueType":"NET",
       "type":"REVSHARE"
       "currency":{...},
       "product":{"id":"product1","displayName":"Product1"},
       "customPaymentTerm":false
     },
     {
        "ratePlanRates":[{
            "revshare":10,
            "startUnit":0,
            "type":"REVSHARE",
            "endUnit":null
        }],
       "revenueType":"NET",
       "type":"REVSHARE"
       "currency":{...},
       "product":{"id":"product2","displayName":"Product2"},
       "customPaymentTerm":false
     }
     ],
     "startDate": "2019-09-15",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/my-package/rate-plans" \
-u email:password

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

$ curl -H "Content-Type:application/json" -X POST -d \
'{
    "ratePlan": [
    {
        "id": "my-package_multi-product-rate-plan",
        "ratePlanDetails": [
        {
            "ratePlanRates":[{
                "revshare":20,
                "startUnit":0,
                "type":"REVSHARE",
                "endUnit":null
             }],
             "revenueType":"NET",
             "type":"REVSHARE"
             "currency":{...},
             "customPaymentTerm":false
         }]
    }]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/my-package/products/product3" \
-u email:password

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

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

דוגמה: המערכת יוצרת תוכנית תמחור פרטית פרטית:

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Simple rate plan",
     "currency": {
      "id" : "usd"
     },
     "description": "Simple rate plan",
     "displayName" : "Simple rate plan",
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },
     "published": true,
     "isPrivate" : true,
     "ratePlanDetails": [
     {
      …
     }
     ],
     "startDate": "2013-09-15",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location_package/rate-plans" \
-u email:password

פרסום תוכנית תעריפים באמצעות ה-API

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

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

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Flat rate card plan",
     "developer":null,
     "developerCategory":null,
     "advance": "false",
     …
     "published": "true",
     "ratePlanDetails": [
     …
      ],
     …
     "type": "RATECARD"
     }],
     …
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

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

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

לדוגמה, כך יוצרים תוכנית מחירון ושומרים אותה כטיוטה (מוצג רק חלק מהבקשה):

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Flat rate card plan",
     "developer":null,
     "developerCategory":null,
     "advance": "false",
     …
     "published": "false",
     "ratePlanDetails": [
     …
      ],
     …
     "type": "RATECARD"
     }],
     …
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

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

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

$ curl -H "Content-Type: application/json" -X PUT -d \
 '{
      "id" : "location_flat_rate_card_plan",
      "name": "Flat rate card plan",
      "advance": "false",
      "currency": {
       "id" : "usd"
      },
      "description": "Flat rate card plan",
      "displayName" : "Flat rate card plan",
      "frequencyDuration": "30",
      "frequencyDurationType": "DAY",
      "earlyTerminationFee": "10",
      "monetizationPackage": {
       "id": "location"
      },
      "organization": {
       "id": "{org_name}"
      },
      "paymentDueDays": "30",
      "prorate": "false",
      "published": "false",
      "ratePlanDetails": [
      {
       "currency": {
        "id" : "usd"
       },
       "paymentDueDays": "30",
       "meteringType": "UNIT",
       "organization": {
        "id": "{org_name}"
       },
       "ratePlanRates": [
        {
         "id" : "26b69b0b-9863-48c9-ba73-74a5b918fcec",
         "type": "RATECARD",
         "rate": "0.15",
         "startUnit": "0"
        }
       ],
      "ratingParameter": "VOLUME",
      "type": "RATECARD"
      }],
      "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/location_flat_rate_card_plan" \
-u email:password

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

…
"ratePlanRates" : [ {
  "id" : "26b69b0b-9863-48c9-ba73-74a5b918fcec",
  "rate" : 0.15,
  "startUnit" : 0,
  "type" : "RATECARD"
} ],
…

הצגת תוכניות תמחור באמצעות ה-API

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

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

כדי להציג את כל תוכניות התעריפים של ארגון מסוים, צריך לשלוח בקשת GET אל /mint/organizations/{org_name}/rate-plans, כאשר {org_name} הוא שם הארגון שלך.

אפשר להעביר את הפרמטרים הבאים של השאילתה כדי לסנן את התוצאות:

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

לדוגמה:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/rate-plans" \
  -u email:password

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

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

כברירת מחדל, בתוצאות מוחזרות רק תוכניות תמחור ותשלומים פעילות, ציבוריות ורגילות. כדי לכלול:

  • בתור טיוטה של תוכניות תעריפים או תוכניות תעריפים שפג תוקפן, צריך להגדיר את פרמטר השאילתה current לערך false (לדוגמה, ?current=false).
  • תוכניות פרטיות – מגדירים את פרמטר השאילתה showPrivate כ-true (לדוגמה, ?showPrivate=true).
  • בכל תוכניות התעריפים הרגילות, צריך להגדיר את פרמטר השאילתה standard כ-true (לדוגמה, ?standard=true).

לדוגמה:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/communications/rate-plans" \
  -u email:password

הצגת תוכנית תעריפים לחבילת API באמצעות ה-API

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

לדוגמה:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/communications/rate-plans/communications_standard_fixed_plan" \
  -u email:password

למטה מוצגת דוגמה לתשובה:

{
   "advance" : true,
   "contractDuration" : 1,
   "contractDurationType" : "YEAR",
   "currency" : {
     "id" : "usd",
     ...
     "organization" : {
       ...
     },
     ...
   },
   "description" : "Standard Fixed Plan",
   "displayName" : "Standard Fixed Plan",
   "earlyTerminationFee" : 0.0000,
   "frequencyDuration" : 1,
   "frequencyDurationType" : "MONTH",
   "id" : "communications_standard_fixed_plan",
   "isPrivate" : false,
   "monetizationPackage" : {
     "description" : "Communications",
     "displayName" : "Communications",
     "id" : "communications",
     "name" : "Communications",
     "organization" : {
      ...
     },
     "product" : [ {
       "customAtt1Name" : "user",
       "description" : "Location",
       "displayName" : "Location",
       "id" : "location",
       "name" : "location",
       "organization" : {
       ...
       },
       "status" : "CREATED"
     }, {
       "customAtt1Name" : "user",
       "description" : "Messaging",
       "displayName" : "Messaging",
       "id" : "messaging",
       "name" : "messaging",
       "organization" : {
         ...
       },
       "status" : "CREATED"
     } ],
     "status" : "CREATED"
   },
   "name" : "Standard Fixed Plan",
   "organization" : {
     ...
   },
   "paymentDueDays" : "30",
   "prorate" : true,
   "published" : true,
   "ratePlanDetails" : [ {
     "aggregateFreemiumCounters" : true,
     "aggregateStandardCounters" : true,
     "currency" : {
       "id" : "usd",
       "name" : "USD",
       "organization" : {
        ...
       },
       "status" : "ACTIVE",
       "virtualCurrency" : false
     },
     "id" : "cb92f7f3-7331-446f-ad63-3e176ad06a86",
     "meteringType" : "UNIT",
     "organization" : {
      ...
     },
     "paymentDueDays" : "30",
     "ratePlanRates" : [ {
       "id" : "07eefdfb-4db5-47f6-b182-5d606c6051c2",
       "rate" : 0.0500,
       "startUnit" : 0,
       "type" : "RATECARD"
     } ],
     "ratingParameter" : "VOLUME",
     "type" : "RATECARD"
   } ],
   "recurringFee" : 200.0000,
   "recurringStartUnit" : 1,
   "recurringType" : "CALENDAR",
   "setUpFee" : 100.0000,
   "startDate" : "2013-01-11 22:00:00",
   "type" : "STANDARD"
 }

הצגת כל תוכניות התעריפים הפעילות של מפתח שמשתמש ב-API

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

אפשר להעביר את הפרמטרים הבאים של השאילתה כדי לסנן את התוצאות:

פרמטר שאילתה התיאור
all סימון שמציין אם להחזיר את כל חבילות ה-API. אם המדיניות מוגדרת כ-false, מספר חבילות ה-API שמוחזרות לכל דף מוגדר על ידי פרמטר השאילתה size. ברירת המחדל היא false.
size מספר חבילות ה-API שהוחזרו בכל דף. ברירת המחדל היא 20. אם פרמטר השאילתה all מוגדר ל-true, המערכת תתעלם מהפרמטר הזה.
page מספר הדף שברצונך להחזיר (אם התוכן מחולק לדפים). אם פרמטר השאילתה all מוגדר ל-true, המערכת תתעלם מהפרמטר הזה.

לדוגמה:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans" \
  -u email:password

למטה מוצגת דוגמה לתשובה:

{
  "ratePlan" : [ {
    "advance" : true,
    "contractDuration" : 1,
    "contractDurationType" : "MONTH",
    "currency" : {
      "description" : "United States Dollar",
      "displayName" : "United States Dollar",
      "id" : "usd",
      "name" : "USD",
      "organization" : {
        ...
      },
      "status" : "ACTIVE",
      "virtualCurrency" : false
    },
    "description" : "Fee Only RatePlan",
    "displayName" : "Fee Only RatePlan",
    "earlyTerminationFee" : 10.0000,
    "freemiumDuration" : 0,
    "freemiumDurationType" : "MONTH",
    "freemiumUnit" : 0,
    "frequencyDuration" : 1,
    "frequencyDurationType" : "WEEK",
    "id" : "messaging_package_fee_only_rateplan",
    "isPrivate" : false,
    "monetizationPackage" : {
      "description" : "messaging package",
      "displayName" : "Messaging Package",
      "id" : "messaging_package",
      "name" : "Messaging Package",
      "organization" : {
        ...
      },
      "product" : [ {
        "customAtt1Name" : "user",
        "customAtt2Name" : "response size",
        "customAtt3Name" : "content-length",
        "description" : "messaging api product",
        "displayName" : "messaging",
        "id" : "messaging",
        "name" : "messaging",
        "organization" : {
         ...
        },
        "status" : "CREATED",
        "transactionSuccessCriteria" : "status == 'SUCCESS'"
      } ],
      "status" : "CREATED"
    },
    "name" : "Fee Only RatePlan",
    "organization" : {
     ...
    },
    "paymentDueDays" : "30",
    "prorate" : false,
    "published" : true,
    "ratePlanDetails" : [ ],
    "recurringFee" : 10.0000,
    "recurringStartUnit" : 1,
    "recurringType" : "CALENDAR",
    "setUpFee" : 20.0000,
    "startDate" : "2013-02-20 00:00:00",
    "type" : "STANDARD"
  } ],
  "totalRecords" : 1
}

הצגת תוכנית תמחור ותשלומים קבילה עבור מפתח שמשתמש ב-API

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

לדוגמה:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans/messaging_package_fee_only_rateplan" \
  -u email:password

למטה מוצגת דוגמה לתשובה:

{
    "created" : "2018-01-25 20:01:54",
    "developer" : {
    },
    "id" : "a73s104-276f-45b3-8075-83d1046ea550",
    "nextCycleStartDate" : "2018-02-19 00:00:00",
    "nextRecurringFeeDate" : "2018-02-19 00:00:00",
    "prevRecurringFeeDate" : "2018-01-25 00:00:00",
    "ratePlan" : {
      "frequencyDuration" : 1,
      "frequencyDurationType" : "MONTH",
      "recurringFee" : 0.0000,
      "recurringStartUnit" : 19,
      "recurringType" : "CALENDAR",
      "setUpFee" : 0.0000,
      "type" : "STANDARD"
    },
    "startDate" : "2018-01-25 20:01:54",
    "updated" : "2018-01-25 20:01:54"
  }

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

כדי להציג תוכנית תעריפים קבילה למפתח שמכיל מוצר API, צריך לשלוח בקשת GET אל /mint/organizations/{org_id}/developers/{developer_id}/products/{product_id}/rate-plan-by-developer-product, כאשר {developer_id} הוא מזהה המפתח ו-/{product_id} הוא מזהה המוצר.

כברירת מחדל, רק תוכנית תעריפים ציבורית מוחזרת בתוצאות. כדי להציג תוכנית תעריפים פרטית, צריך להגדיר את פרמטר השאילתה showPrivate ל-true (לדוגמה, ?showPrivate=true).

לדוגמה:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/products/location/rate-plan-by-developer-product" \
  -u email:password

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

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

אפשר להעביר את הפרמטרים הבאים של השאילתה כדי לסנן את התוצאות:

פרמטר שאילתה התיאור
all סימון שמציין אם להחזיר את כל חבילות ה-API. אם המדיניות מוגדרת כ-false, מספר חבילות ה-API שמוחזרות לכל דף מוגדר על ידי פרמטר השאילתה size. ברירת המחדל היא false.
size מספר חבילות ה-API שהוחזרו בכל דף. ברירת המחדל היא 20. אם פרמטר השאילתה all מוגדר ל-true, המערכת תתעלם מהפרמטר הזה.
page מספר הדף שברצונך להחזיר (אם התוכן מחולק לדפים). אם פרמטר השאילתה all מוגדר ל-true, המערכת תתעלם מהפרמטר הזה.

לדוגמה:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-accepted-rateplans" \
  -u email:password

למטה מוצגת דוגמה לתשובה:

{
  "developerRatePlan" : [ {
     "created" : "2018-01-25 20:01:54",
     "developer" : { ...
     },
     "id" : "a73s104-276f-45b3-8075-83d1046ea550",
     "nextCycleStartDate" : "2018-02-19 00:00:00",
     "nextRecurringFeeDate" : "2018-02-19 00:00:00",
     "prevRecurringFeeDate" : "2018-01-25 00:00:00",
     "ratePlan" : {
       "frequencyDuration" : 1,
       "frequencyDurationType" : "MONTH",
       "recurringFee" : 0.0000,
       "recurringStartUnit" : 19,
       "recurringType" : "CALENDAR",
       "setUpFee" : 0.0000,
       "type" : "STANDARD"
     },
     "startDate" : "2018-01-25 20:01:54",
     "updated" : "2018-01-25 20:01:54"
   }],
   "totalRecords" : 1
}

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

כדי למחוק טיוטה של תוכנית תמחור ותשלומים, צריך לשלוח בקשת DELETE אל /organizations/{org_name}/monetization-packages/package_id}/rate-plans/{plan_Id}. {plan_Id} הוא המזהה של תוכנית התמחור והתשלומים שיש למחוק, ו- {package_id} הוא המזהה של חבילת ה-API עבור תוכנית התמחור והתשלומים. לדוגמה:

$ curl -H "Accept:application/json" -X DELETE \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans/location_flat_rate_card_plan" \
-u email:password

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

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

שם התיאור ברירת המחדל חובה?
advance

תקף לעמלות חוזרות בלבד. סימון שמציין אם העמלה החוזרת חויבה מראש או לא. הערכים החוקיים כוללים:

  • true – עמלה חוזרת נגבית מראש. לדוגמה, אם התקופה היא חודש אחד, העמלה הקבועה תחויב בחשבונית שהופקה בסיום חודש החיוב הקודם.
  • false – בסוף התקופה נחייב את העמלה באופן קבוע. לדוגמה, אם התקופה היא חודש אחד, העמלה הקבועה תחויב בחשבונית בסיום חודש החיוב הנוכחי. (זוהי ברירת המחדל)
 false לא
contractDuration

אורך החוזה של התוכנית יחד עם contractDurationType. לדוגמה, כדי לציין משך חוזה של 6 חודשים, מגדירים את contractDuration לערך 6 ואת contractDurationType כ-MONTH.

 לא רלוונטי לא
contractDurationType

אורך החוזה של התוכנית יחד עם contractDuration. הערכים החוקיים כוללים:

  • DAY
  • WEEK
  • MONTH
  • QUARTER
  • YEAR
 לא רלוונטי לא
currency

המטבע המשמש בתוכנית התמחור. צריך לציין את קוד ISO 4217 של המטבע, למשל usd לדולר ארה"ב או chf לפרנק שוויצרי.

 לא רלוונטי כן
description

תיאור של תוכנית התמחור והתשלומים.

 לא רלוונטי כן
developer

מזהה המפַתח (כתובת אימייל). יש לציין זאת לתוכניות תעריפים למפתחים בלבד.

 לא רלוונטי לא
developerCategory

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

 לא רלוונטי לא
displayName

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

 לא רלוונטי כן
earlyTerminationFee

תחויבו בעמלה חד-פעמית אם המפתח יסיים את התוכנית לפני תקופת החידוש.

 לא רלוונטי לא
endDate

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

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

הערה: כשמציגים את תוכנית התעריפים באמצעות ה-API, חותמת הזמן של endDate מצוינת כ-YYYY-MM-DD 00:00:00, דבר שעשוי להטעות.

 לא רלוונטי לא
freemiumDuration

תקופת הזמן של תקופת ה-freemium יחד עם freemiumDurationType. לדוגמה, כדי לציין שהתקופה בחינם היא 30 יום, מגדירים את freemiumDuration לערך 30 ואת freemiumDurationType ל-DAY.

 לא רלוונטי לא
freemiumDurationType

תקופת הזמן של תקופת ה-freemium יחד עם freemiumDuration. הערכים החוקיים כוללים:

  • DAY
  • WEEK
  • MONTH
  • QUARTER
  • YEAR
 לא רלוונטי לא
freemiumUnit

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

 לא רלוונטי לא
frequencyDuration

תקף לעמלות חוזרות בלבד. פרק הזמן בין חיובי העמלה הקבועים לבין עם frequencyDurationType. לדוגמה, כדי לציין שפרק הזמן בין חיובי העמלה הוא 30 ימים, צריך להגדיר את frequencyDuration כ-30 ואת frequencyDurationType ל-DAY.

 לא רלוונטי לא
frequencyDurationType תקף לעמלות חוזרות בלבד. פרק הזמן בין חיובי העמלה הקבועים לבין עם frequencyDuration. הערכים החוקיים כוללים:
  • DAY
  • WEEK
  • MONTH
  • QUARTER
  • YEAR
 לא רלוונטי לא
isPrivate סימון שמציין אם תוכנית התעריפים היא ציבורית או פרטית. ברירת המחדל היא false (ציבורי). מידע נוסף זמין במאמר תוכניות תעריפים ציבוריות לעומת תוכניות תעריפים פרטיות. לא רלוונטי לא
monetizationPackage

מזהה חבילת מוצרים ב-API לתוכנית התעריפים.

 לא רלוונטי לא
name

השם של תוכנית התמחור והתשלומים.

 לא רלוונטי כן
organization

מזהה הארגון של תוכנית התמחור והתשלומים.

 לא רלוונטי כן
paymentDueDays

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

 לא רלוונטי לא
proRate

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

  • true – העמלה הראשונית מחושבת באופן יחסי לפי מספר הימים עד סוף התקופה (או מספר הימים שהיו בשימוש בתקופה).
  • false - המפתח מחויב בעמלה הראשונית המלאה ללא קשר למועד שבו המפתח מתחיל (או מסיים) את התוכנית. (זוהי ברירת המחדל)
 false לא
published

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

  • true - פרסום תוכנית התמחור והתשלומים.
  • false – אין לפרסם את תוכנית התמחור והתשלומים.
 לא רלוונטי כן
ratePlanDetails

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

 לא רלוונטי כן
recurringFee

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

 לא רלוונטי לא
recurringStartUnit

בתוקף רק אם בשדה recurringType מוגדר הערך CALENDAR. היום בחודש לחיוב העמלה הקבועה. לדוגמה, אם העמלה הקבועה היא חודשית ו-recurringStartUnit מוגדר ל-1, העמלה הקבועה תחויב ביום הראשון של כל חודש.

 לא רלוונטי לא
recurringType

תזמון של התשלום החוזר. הערכים החוקיים כוללים:

  • CALENDAR - מתוזמן לפי יומן.
  • CUSTOM - מתוזמן על סמך הגדרת תאריך מותאמת אישית.
 לא רלוונטי לא
setUpFee

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

 לא רלוונטי לא
startDate

התאריך שבו התוכנית מתחילה. מפתחים יכולים להציג את תוכנית התמחור והתשלומים החל מהתאריך הזה.

 לא רלוונטי כן
type

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

  • STANDARD. חלה על כל המפתחים.
  • DEVELOPER_CATEGORY. חלה על כל המפתחים בקטגוריה נבחרת.
  • DEVELOPER. רלוונטי למפתח או לחברה ספציפיים.
 לא רלוונטי כן

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

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

שם התיאור ברירת המחדל חובה?
aggregateFreemiumCounters

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

  • true - הפעלת מונים מצטברים.
  • false – אין להפעיל מונים מצטברים.
 לא רלוונטי לא
aggregateStandardCounters

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

  • true - שימוש במונים מצטברים.
  • false – אין להשתמש במונים מצטברים.
 לא רלוונטי לא
aggregateTransactions

הערה: הנכס הזה לא משמש כרגע למונטיזציה, ואפשר להתעלם ממנו.

 true לא
currency

המרת מטבעות

 לא רלוונטי לא
duration

תקופת הזמן של תדירות החישוב, יחד עם durationType, שבה ערכי duration המותרים הם 1-24.

לדוגמה, מגדירים את duration לערך 2 ואת durationType ל-MONTH כדי לציין תדירות חישוב של חודשיים.

 לא רלוונטי לא
durationType

תקופת הזמן של תדירות החישוב, יחד עם duration. הערך החוקי היחיד הוא MONTH.

אפשר לראות דוגמה לשימוש בקטע duration.

 לא רלוונטי לא
freemiumDuration

תקופת הזמן של תקופת ה-freemium למוצר מסוים של ה-API, ביחד עם freemiumDurationType. לדוגמה, כדי לציין שתקופת ה-freemium למוצר ה-API היא 30 יום, מגדירים את freemiumDuration ל-30 ואת freemiumDurationType כ-DAY.

 לא רלוונטי לא
freemiumDurationType

תקופת הזמן של תקופת ה-freemium למוצר מסוים של ה-API, ביחד עם freemiumDuration. הערכים החוקיים כוללים:

  • DAY
  • WEEK
  • MONTH
  • QUARTER
  • YEAR

לדוגמה, כדי לציין שתקופת ה-freemium במוצר API היא 30 יום, מגדירים את freemiumDuration ל-30 ואת freemiumDurationType ל-DAY.

 לא רלוונטי לא
freemiumUnit

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

 לא רלוונטי לא
meteringType

מודל חיוב לפי תוכנית מחירון. הערכים החוקיים כוללים:

  • UNIT - מודל טעינה בתשלום קבוע.
  • VOLUME - דגם טעינה עם תדר אחד לתדר.
  • STAIR_STEP – דגם טעינה בחבילה.
  • DEV_SPECIFIC - מודל טעינה ניתן להתאמה של התראות. לא תקף לאף מודל הכנסה אחר.
 לא רלוונטי כן
organization

מזהה הארגון.

 לא רלוונטי לא
paymentDueDays

מועד הפירעון של התשלום למפתחים שמשלמים לאחר השימוש (postpay). לדוגמה, אפשר להגדיר את הערך 30 כדי לציין שמועד הפירעון של התשלום יחול תוך 30 יום.

 לא רלוונטי לא
product

פרטי מוצר של API, כגון מזהה

 לא רלוונטי לא
ratePlanRates

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

 לא רלוונטי כן
ratingParameter

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

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

היחידה שרלוונטית ל-ratingParameter. Only required if ratingParameter מוגדרת למאפיין מותאם אישית (כלומר, לא מוגדר ל-VOLUME).

 לא רלוונטי כן
revenueType

הבסיס של חלוקת ההכנסות בתוכנית של חלוקת הכנסות. הערכים החוקיים כוללים:

  • GROSS - חלוקת ההכנסות מבוססת על אחוז מהמחיר ברוטו של עסקה.
  • NET - חלוקת ההכנסות מבוססת על אחוז מהמחיר נטו של עסקה.
 לא רלוונטי לא
type

סוג תוכנית תמחור ותשלומים. הערכים החוקיים כוללים:

  • REVSHARE – מודל חלוקת הכנסות.
  • RATECARD - מודל מחירון.
  • REVSHARE_RATECARD - מודל חלוקת הכנסות ומודל מחירון.
  • USAGE_TARGET - מודל התראות ניתן להתאמה.

מידע נוסף על הסוגים של תוכניות תעריפים זמין במאמר סוגים נתמכים של תוכניות תעריפים.

 לא רלוונטי כן