הגדרה של תוכנית חלוקת הכנסות

אתם צופים במסמכי העזרה של Apigee Edge.
כניסה למסמכי העזרה של Apigee X. info

מבוא

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

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

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

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

ציון פרטי תוכנית חלוקת ההכנסות באמצעות ה-API

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

ציון פרטי תוכנית חלוקת ההכנסות במודל חלוקה קבוע

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

• פרמטר דירוג שמציין שתוכנית התעריפים מבוססת על עסקאות (VOLUME). VOLUME הוא ערך ברירת המחדל.
• סוג מדידה (UNIT) שמציין שחלוקת ההכנסות קבועה לכל יחידה (כלומר, היא לא מבוססת על נפח העסקאות, כמו במקרה של מודל השיתוף הגמיש).
• סוג ההכנסה (GROSS או NET). הנתון הזה מציין אם חלוקת ההכנסות מבוססת על המחיר ברוטו או הנטו של העסקה.
• תקופת היעד לתשלום (למשל, 30 ימים).
• המזהה של הארגון.
• המטבע 'הבסיסי' או המטבע החשבונאי שבו החברה משתמשת.
• שיעור של תוכנית תעריפים שמספק פרטים על אופן החישוב של חלוקת ההכנסות. מכיוון שמודל השיתוף מבוסס על תעריף קבוע, צריך לציין רק תעריף תוכנית אחד לתעריפים.

בקישור הבא אפשר למצוא רשימה מלאה של מאפייני פרטי תוכנית התמחור: מאפייני תצורה של פרטי תוכנית התמחור.

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

• הסוג של התעריף של תוכנית התמחור (REVSHARE).
• האחוז שמשמש לחישוב חלוקת ההכנסות. לדוגמה, אם מציינים 80.5555, חלוקת ההכנסות היא 80.5555%, כלומר, כספקי API, התשלום למפתח יהיה 80.5555% מהמחיר שחויב עבור כל עסקה (או אם לפי מאפיין מותאם אישית כמו מספר הבייטים שמועברים בבייטים, תשלמו למפתח 80.5555% מהמחיר שצוין).
• היחידה ההתחלתית של הבקשה לתעריף (0). המשמעות היא שהשיעור חל על כל עסקה, החל מהעסקה הראשונה.

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

לדוגמה, הקוד הבא יוצר תוכנית חלוקת הכנסות עם מודל חלוקה קבוע. אחוז חלוקת ההכנסות הוא 80.5555%. חלוקת ההכנסות מבוססת על המחיר נטו של העסקה. החוזה בתוקף מ-15 בספטמבר 2013, והתשלום נדרש תוך 30 יום. (הפרטים הקשורים לחלוקת ההכנסות מודגשים).

$ curl -H "Content-Type:application/json" -X POST -d \
'{
    "name": "Fixed share plan",
    "developer":null,
    "developerCategory":null,
    "advance": false,
    "currency": {
      "id": "usd"
    },
    "description": "Fixed share plan",
    "displayName": "Fixed share plan",
    "earlyTerminationFee": 10,    
    "monetizationPackage": {
      "id": "location"
    },    
    "organization": {
      "id": "{org_name}"
    },
    "paymentDueDays": "30",
    "prorate": false,
    "published": true,
    "ratePlanDetails": [
      {
        "aggregateStandardCounters": true,
        "currency": {
         "id": "usd"
        },
        "duration": 1,
        "durationType": "MONTH",
        "meteringType": "UNIT",
        "organization": {
         "id": "{org_name}"
        },
        "paymentDueDays": "30",
        "ratePlanRates": [
         {
          "revshare": 80.8555,
          "startUnit": 0,
          "type": "REVSHARE"
         }
        ],
        "ratingParameter": "VOLUME",
        "revenueType": "NET",
        "type": "REVSHARE"
      }
    ],
    "recurringStartUnit": 1,
    "recurringType": "CALENDAR",
    "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

התגובה אמורה להיראות כך (מוצג רק חלק מהתגובה):

{
  "advance" : false,
  "currency" : {
    "id" : "usd",
    "name" : "USD",
    ...
    "organization" : {
      ...
    },
   ...
  },
  "description" : "Fixed share plan",
  "displayName" : "Fixed share plan",
  "earlyTerminationFee" : 10,
  "id" : "location_fixed_share_plan",
  "monetizationPackage" : {
    "description" : "Location",
    "displayName" : "Location",
    "id" : "location",
    "name" : "Location",
    "organization" : {
     ...
    },
    "product" : [ {
      "customAtt1Name" : "user",
      "description" : "Location",
      "displayName" : "Location",
      "id" : "location",
      "name" : "location",
      "organization" : {
        ...
      },
      "status" : "CREATED"
    } ],
    "status" : "CREATED"
  },
  "name" : "Fixed share plan",
  "organization" : {
    ...
  },
  "paymentDueDays" : "30",
  "prorate" : false,
  "published" : true,
  "ratePlanDetails" : [ {
    "aggregateFreemiumCounters" : true,
    "aggregateStandardCounters" : true,
    "currency" : {
      "id" : "usd",
      "name" : "USD",
      ...
      "organization" : {
        ...
      },
      ...
    },
    "duration" : 1,
    "durationType" : "MONTH",
    "id" : "c1720153-c60f-4f7f-b4e5-cdc7bc7bec5b",
    "meteringType" : "UNIT",
    "organization" : {
      ...
    },
    "paymentDueDays" : "30",
    "ratePlanRates" : [ {
      "id" : "01c4d544-d907-423b-964e-4e2aed2816a3",
      "revshare" : 80.8555,
      "startUnit" : 0,
      "type" : "REVSHARE"
    } ],
    "ratingParameter" : "VOLUME",
    "revenueType" : "NET",
    "type" : "REVSHARE"
  } ],
  "recurringStartUnit" : 1,
  "recurringType" : "CALENDAR",
  "setUpFee" : 10,
  "startDate" : "2013-09-15 00:00:00",
  "type" : "STANDARD"
}

ציון פרטי תוכנית חלוקת ההכנסות במודל חלוקה גמיש

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

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

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

בקישור הבא אפשר למצוא רשימה מלאה של מאפייני פרטי תוכנית התמחור: מאפייני תצורה של פרטי תוכנית התמחור.

לכל תמחור של תוכנית התמחור, מציינים את הפרטים הבאים:

• הסוג של התעריף של תוכנית התמחור בתחום ההכנסה (REVSHARE).
• האחוז שמשמש לחישוב חלוקת ההכנסות לפי טווח ההכנסות. לדוגמה, אם מציינים 80.5555, חלוקת ההכנסות לטווח ההכנסות היא 80.5555%. כלומר, כספקי API, התשלום למפתח יהיה 80.5555% מהמחיר שחויב על כל עסקה בטווח ההכנסות.
• היחידה הראשונה והיחידה האחרונה בטווח ההכנסות. היחידה ההתחלתית מציינת את הגבול התחתון של פס ההכנסה, ויחידת הסיום מציינת את הגבול העליון של תדר ההכנסות. לדוגמה, אם מציינים יחידה התחלתית של 0 ויחידת סיום של 1,000, טווח ההכנסות מכסה הכנסות מעסקאות שגדולות מ-0 ועד 1,000 במטבע שצוין. אם המטבע הוא דולר ארה"ב, בסיס הצבירה הוא חודש אחד והאחוז מטווח ההכנסות הוא 80.5555%, אז בעסקאות שמייצרות הכנסות של עד 1,000 $בחודש, חלוקת ההכנסות היא 80.5555% ממחיר העסקה.

  אם לא מציינים יחידה סופית לטווח ההכנסה הסופי, אחוז השותפות באותו טווח יחול על כל העסקאות אחרי שההכנסה המצטברת תחרוג מהיחידה ההתחלתית של אותו טווח. לדוגמה, אם יחידת ההתחלה של הקבוצה האחרונה היא 1,000 (נניח בדולר ארה"ב), ולא ציינתם יחידת סיום לקבוצה הזו, אחוז ההכנסה של הקבוצה יחול על כל העסקאות שמניבות הכנסה של יותר מ-1,000 $במהלך התקופה המצטברת.

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

לדוגמה, בדוגמה הבאה נוצרת תוכנית לחלוקת הכנסות עם מודל שיתוף גמיש. הוא מציין שני טווחי הכנסה. הפס הראשון מכסה הכנסות מעסקאות בסכום של יותר מ-1,000 דולר ארה"ב. הפס השני מכסה הכנסות מעסקאות בסך 1,000 דולר ארה"ב ומעלה. אחוז החלק בהכנסות הוא 80.5555% בתחום ההכנסות הראשון, ו-90.5% בתחום ההכנסות השני. חלוקת ההכנסות מבוססת על המחיר נטו של העסקה. בסיס הצבירה הוא חודש אחד. תקופת החוזה תיכנס לתוקף ב-15 בספטמבר 2013, והתשלום יחול בעוד 30 יום. (הפרטים הקשורים לחלוקת ההכנסות מודגשים).

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Flexible share plan",
     "developer":null,
     "developerCategory":null,
     "advance": "true",
     "currency": {
      "id": "usd"
     },
     "description": "Flexible share plan",
     "displayName": "Flexible share plan",   
     "frequencyDuration": "30",
     "frequencyDurationType": "DAY",
     "earlyTerminationFee": "10",       
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },
     "paymentDueDays": "30",
     "prorate": "false",
     "published": "true",
     "ratePlanDetails": [
     {
      "currency": {
       "id": "usd"
      },
      "duration": "1",
      "durationType": "MONTH",
      "meteringType": "VOLUME",
      "organization": {
       "id": "{org_name}"
      },
      "paymentDueDays": "30",
      "ratePlanRates" : [ {
       "endUnit" : 1000,
       "revshare" : 80.5555,
       "startUnit" : 0,
       "type" : "REVSHARE"
      }, {
       "revshare" : 90.5,
       "startUnit" : 1000,
       "type" : "REVSHARE"
      } ],
     "ratingParameter" : "VOLUME",
     "revenueType" : "NET",
     "type" : "REVSHARE"
    } ],
    "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

התגובה אמורה להיראות כך (מוצג רק חלק מהתגובה):

{
  "advance" : true,
  "currency" : {
    "id" : "usd",
    "name" : "USD",
    "organization" : {
      ...
    },
    ...
  },
  "description" : "Flexible share plan",
  "displayName" : "Flexible share plan",
  "earlyTerminationFee" : 10,
  "frequencyDuration" : 30,
  "frequencyDurationType" : "DAY",
  "id" : "location_flexible_share_plan",
  "monetizationPackage" : {
    "description" : "Location",
    "displayName" : "Location",
    "id" : "location",
    "name" : "Location",
    "organization" : {
      ...
    },
    "product" : [ {
      "customAtt1Name" : "user",
      "description" : "Location",
      "displayName" : "Location",
      "id" : "location",
      "name" : "location",
      "organization" : {
        ...
      },
      "status" : "CREATED"
    } ],
    "status" : "CREATED"
  },
  "name" : "Flexible share plan",
  "organization" : {
    ...
  },
  "paymentDueDays" : "30",
  "prorate" : false,
  "published" : false,
  "ratePlanDetails" : [ {
    "aggregateFreemiumCounters" : true,
    "aggregateStandardCounters" : true,
    "currency" : {
      "id" : "usd",
      "name" : "USD",
       …
      "organization" : {
        ...
      },
      ...
    },
    "duration" : 1,
    "durationType" : "MONTH",
    "id" : "ba3353e3-14f4-4bc5-a9f1-c723fd34131c",
    "meteringType" : "VOLUME",
    "organization" : {
      ...
    },
    "paymentDueDays" : "30",
    "ratePlanRates" : [ {
      "endUnit" : 1000,
      "id" : "5f13a51e-2250-4383-9aad-35e9a008ab40",
      "revshare" : 80.5555,
      "startUnit" : 0,
      "type" : "REVSHARE"
    }, {
      "id" : "d4196250-4ecc-480e-a7ed-dfab8e1c92ed",
      "revshare" : 90.5,
      "startUnit" : 1000,
      "type" : "REVSHARE"
    } ],
    "ratingParameter" : "VOLUME",
    "revenueType" : "NET",
    "type" : "REVSHARE"
  } ],
  "recurringFee" : 10,
  "recurringStartUnit" : 1,
  "recurringType" : "CALENDAR",
  "setUpFee" : 10,
  "startDate" : "2013-09-15 00:00:00",
  "type" : "STANDARD"
}