پیکربندی طرح سهم درآمد

شما در حال مشاهده اسناد 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 روز).
• شناسه سازمان شما
• "پایه" یا ارز حسابداری که شرکت شما استفاده می کند.
• نوع مدت و مدت زمانی که با هم دوره زمانی را مشخص می‌کند که در آن درآمد جمع می‌شود (به این «مبنای تجمیع» نیز می‌گویند). تراکنش ها بر اساس تجمیع (به عنوان مثال، 1 ماه) برای محاسبه کل درآمد و باند درآمد قابل اجرا جمع می شوند. درصد سهم درآمد اعمال شده برای هر تراکنش به باند درآمد آن بستگی دارد.
• شمارنده های تجمیع که برای تعیین باند درآمد قابل اجرا استفاده می شوند.

مشخصات پیکربندی را برای جزئیات طرح نرخ برای لیست کامل ویژگی های جزئیات طرح نرخ ببینید.

برای هر نرخ طرح نرخ، شما مشخص می کنید:

• نوع نرخ طرح نرخ برای باند درآمد ( REVSHARE ).
• درصدی که برای محاسبه سهم درآمد برای باند درآمد استفاده می شود. به عنوان مثال، اگر 80.5555 را مشخص کنید، سهم درآمد برای باند درآمد 80.5555٪ است، یعنی به عنوان یک ارائه دهنده API، 80.5555٪ از قیمت هر تراکنش در آن باند درآمد را به توسعه دهنده می پردازید.
• واحد شروع و پایان باند درآمد. واحد شروع حد پایین باند درآمد را مشخص می کند و واحد پایانی حد بالای باند درآمد را مشخص می کند. به عنوان مثال، اگر یک واحد شروع 0 و یک واحد پایانی 1000 را مشخص کنید، باند درآمد درآمد تراکنش های بیشتر از 0 و تا 1000 را در ارز مشخص شده پوشش می دهد. اگر واحد پول دلار آمریکا باشد، مبنای تجمیع 1 ماه و درصد باند درآمد 80.5555 درصد است، در این صورت برای تراکنش هایی که تا 1000 دلار در ماه درآمد ایجاد می کنند، سهم درآمد 80.5555 درصد از قیمت تراکنش است.

  اگر واحد پایانی را برای باند درآمد نهایی مشخص نکنید، درصد سهم برای آن باند برای همه تراکنش‌ها اعمال می‌شود، پس از اینکه درآمد کل از واحد شروع آن باند بالاتر رفت. به عنوان مثال، اگر واحد شروع آخرین باند 1000 باشد (دلار آمریکا را فرض کنید)، و واحد پایانی را برای آن باند مشخص نکنید، درصد درآمد باند برای تمام تراکنش‌های بالاتر از 1000 دلار درآمد در طول دوره کل اعمال می‌شود.

برای فهرست کاملی از ویژگی‌های طرح نرخ به ویژگی‌های پیکربندی برای طرح‌های نرخ رجوع کنید.

به عنوان مثال، موارد زیر یک طرح سهم درآمد با یک مدل اشتراک گذاری انعطاف پذیر ایجاد می کند. دو باند درآمد را مشخص می کند. باند اول درآمد تراکنش های بیش از 1000 دلار آمریکا را پوشش می دهد. باند دوم درآمد تراکنش های بیش از 1000 دلار آمریکا را پوشش می دهد. درصد سهم درآمد برای باند درآمد اول 80.5555 درصد و برای باند درآمد دوم 90.5 درصد است. سهم درآمد بر اساس قیمت خالص یک معامله است. مبنای تجمیع 1 ماه است. مدت قرارداد از 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"
}