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

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

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

עיון בדף תוכניות התמחור והתשלומים

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

Edge

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

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

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

כפי שמוצג באיור, הדף 'תוכניות מחירים' מאפשר לכם:

Classic Edge (ענן פרטי)

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

  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. מושבת
    הגדרת הצעת המחיר החינמית של כל מוצר בנפרד סימון שמציין אם להגדיר תוכנית ללא תשלום לכל מוצר API. מושבת
    בחר מוצר אם מפעילים אחד מהדגלים או את שניהם, צריך לבחור כל מוצר בנפרד מהרשימה הנפתחת ולהגדיר את פרטי תוכנית התמחור שלו.

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

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

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

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

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

  8. מצרפים את המדיניות בנושא בדיקת הגבלות מונטיזציה לשרתי ה-proxy ל-API שמשויכים למוצרי ה-API שכלולים בתוכנית התעריפים. המדיניות בנושא בדיקת הגבלות המונטיזציה אוכפת מגבלות מונטיזציה בשרתי ה-proxy ל-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:

$ 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