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

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

מבוא

בתוכנית של חלוקת הכנסות, ספק ה-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"
}