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

شما در حال مشاهده مستندات Apigee Edge هستید.
به مستندات Apigee X مراجعه کنید .
اطلاعات

مقدمه

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

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

مشخص کردن جزئیات طرح سهم درآمد با استفاده از رابط کاربری

طرح‌های سهم درآمد را مطابق توضیحات زیر پیکربندی کنید.

لبه

برای پیکربندی طرح سهم درآمد با استفاده از رابط کاربری Edge، هنگام ایجاد یا ویرایش طرح نرخ، نوع طرح نرخ سهم درآمد یا کارت نرخ و طرح نرخ سهم درآمد را انتخاب کنید و در بخش سهم درآمد، اطلاعات زیر را پیکربندی کنید:

میدان توضیحات
مدل محاسبه یکی از انواع قیمت‌گذاری زیر را انتخاب کنید:
  • ناخالص - سهم درآمد بر اساس درصدی از قیمت ناخالص یک معامله محاسبه می‌شود.
  • خالص - سهم درآمد بر اساس درصدی از قیمت خالص یک معامله است
توجه : شما هنگام ایجاد سیاست ثبت تراکنش، قیمت ناخالص یا خالص تراکنش را تعیین می‌کنید.
فرکانس محاسبه دوره زمانی که حجم تراکنش‌ها (یا حجم مربوط به ویژگی سفارشی) در آن محاسبه می‌شود. تعداد ماه‌ها (۱ تا ۲۴ ماه) را انتخاب کنید.
مدل اشتراک‌گذاری یکی از مدل‌های تقسیم درآمد زیر را انتخاب کنید:
  • ثابت - ارائه‌دهنده API درصد ثابتی از درآمد حاصل از هر تراکنش (بر اساس قیمت ناخالص یا خالص یک تراکنش) را با توسعه‌دهنده به اشتراک می‌گذارد.
  • انعطاف‌پذیر - ارائه‌دهنده API درصد متغیری از درآمد را با توسعه‌دهنده به اشتراک می‌گذارد. سهم درآمد به درآمد حاصل از یک دوره زمانی بستگی دارد. درصد مورد استفاده در محاسبه سهم درآمد می‌تواند بر اساس میزان درآمد حاصل از تراکنش‌ها متفاوت باشد.
سهم درآمد ثابت برای مدل اشتراک‌گذاری ثابت، درصد مورد استفاده برای محاسبه سهم درآمد را مشخص می‌کند. یک عدد اعشاری (تا چهار رقم اعشار) وارد کنید. برای مثال، اگر 80.5555 را وارد کنید، سهم درآمد 80.5555٪ است، یعنی به عنوان ارائه‌دهنده API، 80.5555٪ از قیمت هر تراکنش را به توسعه‌دهنده پرداخت می‌کنید.
باندهای سهم درآمد

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

حد بالای اولین باند را مشخص کنید، مثلاً تا ۱۰۰۰ (حد پایین از پیش روی بزرگتر از ۰ تنظیم شده است). برای افزودن باندهای بیشتر، روی +جدید کلیک کنید. حد بالای آخرین باند را خالی بگذارید تا تمام تراکنش‌ها را پس از اینکه درآمد کل از این سطح بالاتر رفت، نشان دهد.

برای مثال، اگر در بخش «رده درآمدی» دو محدوده درآمدی (بالای 0 تا 1000 و بالای 1000) مشخص کنید، می‌توانید برای محدوده درآمدی بالای 0 تا 1000 عدد 80.5555 و برای محدوده درآمدی بالای 1000 عدد 90.5 را وارد کنید. همچنین فرض کنید ارز مورد استفاده دلار آمریکا باشد. در این صورت، برای تراکنش‌هایی که تا سقف 1000 دلار درآمد ایجاد می‌کنند، سهم درآمد 80.5555٪ از قیمت تراکنش و برای تراکنش‌هایی که بیش از 1000 دلار درآمد ایجاد می‌کنند، سهم درآمد 90.5٪ از قیمت تراکنش است.

لبه کلاسیک (ابر خصوصی)

برای پیکربندی طرح‌های سهم درآمد با استفاده از رابط کاربری کلاسیک اج:

  1. برای ایجاد یک طرح تعرفه، مراحل را دنبال کنید.
  2. برای پیکربندی مدل درآمد، در منوی کشویی نوع طرح نرخ، سهم درآمد را انتخاب کنید.
  3. اگر بسته API انتخاب شده شامل چندین محصول API است، یکی از گزینه‌های زیر را انتخاب کنید:

    توجه : اگر بسته API شامل یک محصول API واحد است، می‌توانید از این مرحله صرف نظر کنید.

    • طرح‌های ویژه محصول برای پیکربندی جزئیات طرح نرخ برای هر محصول API به صورت جداگانه.
    • طرح عمومی برای همه محصولات برای پیکربندی جزئیات طرح نرخ برای همه محصولات API.
  4. برای طرح نرخ عمومی یا برای هر طرح نرخ ویژه محصول API، روی «سهم درآمد» کلیک کنید.

    توجه : هنگام پیکربندی طرح‌های مختص محصول API، باید برای هر محصول API به صورت جداگانه یک طرح سهم درآمد پیکربندی کنید.

    پنجره سهم درآمد باز می‌شود.

  5. یکی از مدل‌های اشتراک‌گذاری زیر را انتخاب کنید:
    • ثابت : در این مدل، ارائه‌دهنده API درصد ثابتی از درآمد حاصل از هر تراکنش (بر اساس قیمت ناخالص یا خالص یک تراکنش) را با توسعه‌دهنده به اشتراک می‌گذارد.
    • انعطاف‌پذیر : در این مدل، ارائه‌دهنده API درصد متغیری از درآمد را با توسعه‌دهنده به اشتراک می‌گذارد. سهم درآمد به درآمد حاصل از یک دوره زمانی بستگی دارد. درصد مورد استفاده در محاسبه سهم درآمد می‌تواند بر اساس میزان درآمد حاصل از تراکنش‌ها متفاوت باشد.

    برای مدل اشتراک‌گذاری ثابت:

    اگر مدل اشتراک‌گذاری ثابت را انتخاب می‌کنید، اطلاعات زیر را در بخش قیمت‌گذاری پنجره سهم درآمد عمومی وارد کنید:

    میدان توضیحات
    اپراتور (یا سازمان)

    نام سازمان شما. این فیلد با استفاده از مقدار فیلد اپراتور (یا سازمان) در پروفایل سازمان از پیش تعیین شده است.

    کشور

    کشور محل فعالیت سازمان شما. این فیلد با استفاده از مقدار فیلد کشور در پروفایل سازمان از پیش تعیین شده است.

    ارز

    «ارز پایه» یا ارز حسابداری که شرکت شما استفاده می‌کند. این فیلد با استفاده از مقدار فیلد ارز در نمایه سازمان از پیش تعیین شده است.

    نوع قیمت گذاری

    مبنای سهم درآمد. ناخالص یا خالص را انتخاب کنید. اگر ناخالص را انتخاب کنید، سهم درآمد بر اساس درصدی از قیمت ناخالص یک معامله محاسبه می‌شود. اگر خالص را انتخاب کنید، سهم درآمد بر اساس درصدی از قیمت خالص یک معامله محاسبه می‌شود. توجه : هنگام ایجاد سیاست ثبت تراکنش، قیمت ناخالص یا خالص را برای معامله تعیین می‌کنید.

    درصد سهم ثابت

    درصد مورد استفاده برای محاسبه سهم درآمد. یک عدد اعشاری (تا چهار رقم اعشار) وارد کنید. برای مثال، اگر 80.5555 را وارد کنید، سهم درآمد 80.5555٪ است، یعنی به عنوان ارائه دهنده API، 80.5555٪ از قیمت هر تراکنش را به توسعه دهنده پرداخت می‌کنید.

    برای مدل اشتراک‌گذاری انعطاف‌پذیر:

    اگر مدل اشتراک‌گذاری انعطاف‌پذیر را انتخاب کنید، متوجه خواهید شد که پنجره‌ی سهم درآمد عمومی، فیلدهای اضافی را نمایش می‌دهد. شما از این فیلدها برای تعیین مبنایی برای تجمیع و تعیین «باندهای درآمدی» استفاده می‌کنید، یعنی محدوده‌هایی از درآمد حاصل از تراکنش که می‌توانید درصدهای سهم درآمد متفاوتی را برای آنها اعمال کنید.

    اطلاعات زیر را در پنجره سهم درآمد عمومی وارد کنید:

    میدان توضیحات
    مبنای تجمیع

    دوره زمانی که درآمد در آن تجمیع می‌شود. درآمد تجمیع شده برای محاسبه محدوده درآمدی برای هر تراکنش (و درصد سهم درآمد مربوطه) استفاده می‌شود. تعداد ماه‌ها را انتخاب کنید (بین ۱ تا ۱۲).

    گروه‌های درآمدی

    یک یا چند محدوده از درآمد تراکنش (هر محدوده یک "محدوده درآمدی" است). به هر محدوده درآمدی می‌توان یک درصد سهم درآمد اختصاص داد (شما این درصد را در فیلد محدوده‌های درآمدی در بخش قیمت‌گذاری تعیین می‌کنید.) تراکنش‌ها بر اساس تجمیع، تجمیع می‌شوند تا کل درآمد و محدوده درآمدی برای تراکنش محاسبه شود. درصد سهم درآمدی که برای هر تراکنش اعمال می‌شود به محدوده درآمدی آن بستگی دارد.

    حد بالای اولین باند را مشخص کنید، مثلاً تا ۱۰۰۰ (حد پایین از پیش روی بزرگتر از ۰ تنظیم شده است). برای اضافه کردن باند دوم، مثلاً بزرگتر از ۱۰۰۰ و تا ۲۰۰۰، روی + کلیک کنید. برای اضافه کردن باندهای بیشتر روی + کلیک کنید. می‌توانید حد بالای آخرین باند را خالی بگذارید تا تمام تراکنش‌ها را پس از اینکه درآمد کل از این سطح بالاتر رفت، نشان دهد.

    قیمت‌گذاری
    اپراتور (یا سازمان)

    نام سازمان شما. این فیلد با استفاده از مقدار فیلد اپراتور (یا سازمان) در پروفایل سازمان از پیش تعیین شده است.

    کشور

    کشور محل فعالیت سازمان شما. این فیلد با استفاده از مقدار فیلد کشور در پروفایل سازمان از پیش تعیین شده است.

    ارز

    «ارز پایه» یا ارز حسابداری که سازمان شما استفاده می‌کند. این فیلد با استفاده از مقدار فیلد ارز در نمایه سازمان از پیش تعیین شده است.

    نوع قیمت گذاری

    مبنای سهم درآمد. ناخالص یا خالص را انتخاب کنید. اگر ناخالص را انتخاب کنید، سهم درآمد بر اساس درصدی از قیمت ناخالص یک معامله محاسبه می‌شود. اگر خالص را انتخاب کنید، سهم درآمد بر اساس درصدی از قیمت خالص یک معامله محاسبه می‌شود. توجه : هنگام ایجاد سیاست ثبت تراکنش، قیمت ناخالص یا خالص را برای معامله تعیین می‌کنید.

    درصد سهم برای گروه‌های درآمدی

    درصد مورد استفاده برای محاسبه سهم درآمد برای تراکنش‌ها در هر گروه درآمدی. شما برای هر گروه یک درصد مشخص می‌کنید. یک عدد اعشاری (تا چهار رقم اعشار) وارد کنید. برای مثال، اگر دو گروه درآمدی را در بخش گروه درآمدی مشخص کنید (>0-1000 و 1000 و بالاتر)، می‌توانید برای گروه درآمدی>0-1000 عدد 80.5555 و برای گروه درآمدی 1000 و بالاتر عدد 90.5 را وارد کنید. همچنین فرض کنید ارز به دلار آمریکا باشد. سپس برای تراکنش‌هایی که تا 1000 دلار درآمد ایجاد می‌کنند، سهم درآمد 80.5555٪ از قیمت تراکنش است و برای تراکنش‌هایی که بیش از 1000 دلار درآمد ایجاد می‌کنند، سهم درآمد 90.5٪ از قیمت تراکنش است.

  6. برای ذخیره جزئیات سهم درآمد و بازگشت به پنجره طرح نرخ استاندارد ، روی اعمال و بستن کلیک کنید.
  7. برای طرح‌های نرخ ویژه محصول API، در صورت نیاز، جزئیات طرح نرخ را برای محصولات 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٪ از قیمت هر تراکنش در آن گروه درآمدی را به توسعه دهنده پرداخت می‌کنید.
  • واحد شروع و پایان محدوده درآمد. واحد شروع، حد پایین محدوده درآمد و واحد پایان، حد بالای محدوده درآمد را مشخص می‌کند. برای مثال، اگر واحد شروع ۰ و واحد پایان ۱۰۰۰ را مشخص کنید، محدوده درآمد، درآمد تراکنش‌های بزرگتر از ۰ و تا ۱۰۰۰ را با ارز مشخص شده پوشش می‌دهد. اگر ارز دلار آمریکا باشد، مبنای تجمیع ۱ ماه است و درصد محدوده درآمد ۸۰.۵۵۵۵٪ است، سپس برای تراکنش‌هایی که تا ۱۰۰۰ دلار درآمد در ماه ایجاد می‌کنند، سهم درآمد ۸۰.۵۵۵۵٪ از قیمت تراکنش است.

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

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

برای مثال، در ادامه یک طرح سهم درآمد با مدل اشتراک‌گذاری انعطاف‌پذیر ایجاد شده است. این طرح دو محدوده درآمدی را مشخص می‌کند. محدوده اول، درآمد تراکنش‌های بیشتر از ۱۰۰۰ دلار آمریکا را پوشش می‌دهد. محدوده دوم، درآمد تراکنش‌های بالای ۱۰۰۰ دلار آمریکا را پوشش می‌دهد. درصد سهم درآمد برای محدوده درآمدی اول ۸۰.۵۵۵۵٪ و برای محدوده درآمدی دوم ۹۰.۵٪ است. سهم درآمد بر اساس قیمت خالص یک تراکنش محاسبه می‌شود. مبنای تجمیع ۱ ماه است. دوره قرارداد از ۱۵ سپتامبر ۲۰۱۳ آغاز می‌شود و پرداخت ظرف ۳۰ روز انجام می‌شود. (جزئیات مربوط به سهم درآمد هایلایت شده‌اند.)

$ 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"
}
،

شما در حال مشاهده مستندات Apigee Edge هستید.
به مستندات Apigee X مراجعه کنید .
اطلاعات

مقدمه

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

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

مشخص کردن جزئیات طرح سهم درآمد با استفاده از رابط کاربری

طرح‌های سهم درآمد را مطابق توضیحات زیر پیکربندی کنید.

لبه

برای پیکربندی طرح سهم درآمد با استفاده از رابط کاربری Edge، هنگام ایجاد یا ویرایش طرح نرخ، نوع طرح نرخ سهم درآمد یا کارت نرخ و طرح نرخ سهم درآمد را انتخاب کنید و در بخش سهم درآمد، اطلاعات زیر را پیکربندی کنید:

میدان توضیحات
مدل محاسبه یکی از انواع قیمت‌گذاری زیر را انتخاب کنید:
  • ناخالص - سهم درآمد بر اساس درصدی از قیمت ناخالص یک معامله محاسبه می‌شود.
  • خالص - سهم درآمد بر اساس درصدی از قیمت خالص یک معامله است
توجه : شما هنگام ایجاد سیاست ثبت تراکنش، قیمت ناخالص یا خالص تراکنش را تعیین می‌کنید.
فرکانس محاسبه دوره زمانی که حجم تراکنش‌ها (یا حجم مربوط به ویژگی سفارشی) در آن محاسبه می‌شود. تعداد ماه‌ها (۱ تا ۲۴ ماه) را انتخاب کنید.
مدل اشتراک‌گذاری یکی از مدل‌های تقسیم درآمد زیر را انتخاب کنید:
  • ثابت - ارائه‌دهنده API درصد ثابتی از درآمد حاصل از هر تراکنش (بر اساس قیمت ناخالص یا خالص یک تراکنش) را با توسعه‌دهنده به اشتراک می‌گذارد.
  • انعطاف‌پذیر - ارائه‌دهنده API درصد متغیری از درآمد را با توسعه‌دهنده به اشتراک می‌گذارد. سهم درآمد به درآمد حاصل از یک دوره زمانی بستگی دارد. درصد مورد استفاده در محاسبه سهم درآمد می‌تواند بر اساس میزان درآمد حاصل از تراکنش‌ها متفاوت باشد.
سهم درآمد ثابت برای مدل اشتراک‌گذاری ثابت، درصد مورد استفاده برای محاسبه سهم درآمد را مشخص می‌کند. یک عدد اعشاری (تا چهار رقم اعشار) وارد کنید. برای مثال، اگر 80.5555 را وارد کنید، سهم درآمد 80.5555٪ است، یعنی به عنوان ارائه‌دهنده API، 80.5555٪ از قیمت هر تراکنش را به توسعه‌دهنده پرداخت می‌کنید.
باندهای سهم درآمد

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

حد بالای اولین باند را مشخص کنید، مثلاً تا ۱۰۰۰ (حد پایین از پیش روی بزرگتر از ۰ تنظیم شده است). برای افزودن باندهای بیشتر، روی +جدید کلیک کنید. حد بالای آخرین باند را خالی بگذارید تا تمام تراکنش‌ها را پس از اینکه درآمد کل از این سطح بالاتر رفت، نشان دهد.

برای مثال، اگر در بخش «رده درآمدی» دو محدوده درآمدی (بالای 0 تا 1000 و بالای 1000) مشخص کنید، می‌توانید برای محدوده درآمدی بالای 0 تا 1000 عدد 80.5555 و برای محدوده درآمدی بالای 1000 عدد 90.5 را وارد کنید. همچنین فرض کنید ارز مورد استفاده دلار آمریکا باشد. در این صورت، برای تراکنش‌هایی که تا سقف 1000 دلار درآمد ایجاد می‌کنند، سهم درآمد 80.5555٪ از قیمت تراکنش و برای تراکنش‌هایی که بیش از 1000 دلار درآمد ایجاد می‌کنند، سهم درآمد 90.5٪ از قیمت تراکنش است.

لبه کلاسیک (ابر خصوصی)

برای پیکربندی طرح‌های سهم درآمد با استفاده از رابط کاربری کلاسیک اج:

  1. برای ایجاد یک طرح تعرفه، مراحل را دنبال کنید.
  2. برای پیکربندی مدل درآمد، در منوی کشویی نوع طرح نرخ، سهم درآمد را انتخاب کنید.
  3. اگر بسته API انتخاب شده شامل چندین محصول API است، یکی از گزینه‌های زیر را انتخاب کنید:

    توجه : اگر بسته API شامل یک محصول API واحد است، می‌توانید از این مرحله صرف نظر کنید.

    • طرح‌های ویژه محصول برای پیکربندی جزئیات طرح نرخ برای هر محصول API به صورت جداگانه.
    • طرح عمومی برای همه محصولات برای پیکربندی جزئیات طرح نرخ برای همه محصولات API.
  4. برای طرح نرخ عمومی یا برای هر طرح نرخ ویژه محصول API، روی «سهم درآمد» کلیک کنید.

    توجه : هنگام پیکربندی طرح‌های مختص محصول API، باید برای هر محصول API به صورت جداگانه یک طرح سهم درآمد پیکربندی کنید.

    پنجره سهم درآمد باز می‌شود.

  5. یکی از مدل‌های اشتراک‌گذاری زیر را انتخاب کنید:
    • ثابت : در این مدل، ارائه‌دهنده API درصد ثابتی از درآمد حاصل از هر تراکنش (بر اساس قیمت ناخالص یا خالص یک تراکنش) را با توسعه‌دهنده به اشتراک می‌گذارد.
    • انعطاف‌پذیر : در این مدل، ارائه‌دهنده API درصد متغیری از درآمد را با توسعه‌دهنده به اشتراک می‌گذارد. سهم درآمد به درآمد حاصل از یک دوره زمانی بستگی دارد. درصد مورد استفاده در محاسبه سهم درآمد می‌تواند بر اساس میزان درآمد حاصل از تراکنش‌ها متفاوت باشد.

    برای مدل اشتراک‌گذاری ثابت:

    اگر مدل اشتراک‌گذاری ثابت را انتخاب می‌کنید، اطلاعات زیر را در بخش قیمت‌گذاری پنجره سهم درآمد عمومی وارد کنید:

    میدان توضیحات
    اپراتور (یا سازمان)

    نام سازمان شما. این فیلد با استفاده از مقدار فیلد اپراتور (یا سازمان) در پروفایل سازمان از پیش تعیین شده است.

    کشور

    کشور محل فعالیت سازمان شما. این فیلد با استفاده از مقدار فیلد کشور در پروفایل سازمان از پیش تعیین شده است.

    ارز

    «ارز پایه» یا ارز حسابداری که شرکت شما استفاده می‌کند. این فیلد با استفاده از مقدار فیلد ارز در نمایه سازمان از پیش تعیین شده است.

    نوع قیمت گذاری

    مبنای سهم درآمد. ناخالص یا خالص را انتخاب کنید. اگر ناخالص را انتخاب کنید، سهم درآمد بر اساس درصدی از قیمت ناخالص یک معامله محاسبه می‌شود. اگر خالص را انتخاب کنید، سهم درآمد بر اساس درصدی از قیمت خالص یک معامله محاسبه می‌شود. توجه : هنگام ایجاد سیاست ثبت تراکنش، قیمت ناخالص یا خالص را برای معامله تعیین می‌کنید.

    درصد سهم ثابت

    درصد مورد استفاده برای محاسبه سهم درآمد. یک عدد اعشاری (تا چهار رقم اعشار) وارد کنید. برای مثال، اگر 80.5555 را وارد کنید، سهم درآمد 80.5555٪ است، یعنی به عنوان ارائه دهنده API، 80.5555٪ از قیمت هر تراکنش را به توسعه دهنده پرداخت می‌کنید.

    برای مدل اشتراک‌گذاری انعطاف‌پذیر:

    اگر مدل اشتراک‌گذاری انعطاف‌پذیر را انتخاب کنید، متوجه خواهید شد که پنجره‌ی سهم درآمد عمومی، فیلدهای اضافی را نمایش می‌دهد. شما از این فیلدها برای تعیین مبنایی برای تجمیع و تعیین «باندهای درآمدی» استفاده می‌کنید، یعنی محدوده‌هایی از درآمد حاصل از تراکنش که می‌توانید درصدهای سهم درآمد متفاوتی را برای آنها اعمال کنید.

    اطلاعات زیر را در پنجره سهم درآمد عمومی وارد کنید:

    میدان توضیحات
    مبنای تجمیع

    دوره زمانی که درآمد در آن تجمیع می‌شود. درآمد تجمیع شده برای محاسبه محدوده درآمدی برای هر تراکنش (و درصد سهم درآمد مربوطه) استفاده می‌شود. تعداد ماه‌ها را انتخاب کنید (بین ۱ تا ۱۲).

    گروه‌های درآمدی

    یک یا چند محدوده از درآمد تراکنش (هر محدوده یک "محدوده درآمدی" است). به هر محدوده درآمدی می‌توان یک درصد سهم درآمد اختصاص داد (شما این درصد را در فیلد محدوده‌های درآمدی در بخش قیمت‌گذاری تعیین می‌کنید.) تراکنش‌ها بر اساس تجمیع، تجمیع می‌شوند تا کل درآمد و محدوده درآمدی برای تراکنش محاسبه شود. درصد سهم درآمدی که برای هر تراکنش اعمال می‌شود به محدوده درآمدی آن بستگی دارد.

    حد بالای اولین باند را مشخص کنید، مثلاً تا ۱۰۰۰ (حد پایین از پیش روی بزرگتر از ۰ تنظیم شده است). برای اضافه کردن باند دوم، مثلاً بزرگتر از ۱۰۰۰ و تا ۲۰۰۰، روی + کلیک کنید. برای اضافه کردن باندهای بیشتر روی + کلیک کنید. می‌توانید حد بالای آخرین باند را خالی بگذارید تا تمام تراکنش‌ها را پس از اینکه درآمد کل از این سطح بالاتر رفت، نشان دهد.

    قیمت‌گذاری
    اپراتور (یا سازمان)

    نام سازمان شما. این فیلد با استفاده از مقدار فیلد اپراتور (یا سازمان) در پروفایل سازمان از پیش تعیین شده است.

    کشور

    کشور محل فعالیت سازمان شما. این فیلد با استفاده از مقدار فیلد کشور در پروفایل سازمان از پیش تعیین شده است.

    ارز

    «ارز پایه» یا ارز حسابداری که سازمان شما استفاده می‌کند. این فیلد با استفاده از مقدار فیلد ارز در نمایه سازمان از پیش تعیین شده است.

    نوع قیمت گذاری

    مبنای سهم درآمد. ناخالص یا خالص را انتخاب کنید. اگر ناخالص را انتخاب کنید، سهم درآمد بر اساس درصدی از قیمت ناخالص یک معامله محاسبه می‌شود. اگر خالص را انتخاب کنید، سهم درآمد بر اساس درصدی از قیمت خالص یک معامله محاسبه می‌شود. توجه : هنگام ایجاد سیاست ثبت تراکنش، قیمت ناخالص یا خالص را برای معامله تعیین می‌کنید.

    درصد سهم برای گروه‌های درآمدی

    درصد مورد استفاده برای محاسبه سهم درآمد برای تراکنش‌ها در هر گروه درآمدی. شما برای هر گروه یک درصد مشخص می‌کنید. یک عدد اعشاری (تا چهار رقم اعشار) وارد کنید. برای مثال، اگر دو گروه درآمدی را در بخش گروه درآمدی مشخص کنید (>0-1000 و 1000 و بالاتر)، می‌توانید برای گروه درآمدی>0-1000 عدد 80.5555 و برای گروه درآمدی 1000 و بالاتر عدد 90.5 را وارد کنید. همچنین فرض کنید ارز به دلار آمریکا باشد. سپس برای تراکنش‌هایی که تا 1000 دلار درآمد ایجاد می‌کنند، سهم درآمد 80.5555٪ از قیمت تراکنش است و برای تراکنش‌هایی که بیش از 1000 دلار درآمد ایجاد می‌کنند، سهم درآمد 90.5٪ از قیمت تراکنش است.

  6. برای ذخیره جزئیات سهم درآمد و بازگشت به پنجره طرح نرخ استاندارد ، روی اعمال و بستن کلیک کنید.
  7. برای طرح‌های نرخ ویژه محصول API، در صورت نیاز، جزئیات طرح نرخ را برای محصولات 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٪ از قیمت هر تراکنش در آن گروه درآمدی را به توسعه دهنده پرداخت می‌کنید.
  • واحد شروع و پایان محدوده درآمد. واحد شروع، حد پایین محدوده درآمد و واحد پایان، حد بالای محدوده درآمد را مشخص می‌کند. برای مثال، اگر واحد شروع ۰ و واحد پایان ۱۰۰۰ را مشخص کنید، محدوده درآمد، درآمد تراکنش‌های بزرگتر از ۰ و تا ۱۰۰۰ را با ارز مشخص شده پوشش می‌دهد. اگر ارز دلار آمریکا باشد، مبنای تجمیع ۱ ماه است و درصد محدوده درآمد ۸۰.۵۵۵۵٪ است، سپس برای تراکنش‌هایی که تا ۱۰۰۰ دلار درآمد در ماه ایجاد می‌کنند، سهم درآمد ۸۰.۵۵۵۵٪ از قیمت تراکنش است.

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

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

برای مثال، در ادامه یک طرح سهم درآمد با مدل اشتراک‌گذاری انعطاف‌پذیر ایجاد شده است. این طرح دو محدوده درآمدی را مشخص می‌کند. محدوده اول، درآمد تراکنش‌های بیشتر از ۱۰۰۰ دلار آمریکا را پوشش می‌دهد. محدوده دوم، درآمد تراکنش‌های بالای ۱۰۰۰ دلار آمریکا را پوشش می‌دهد. درصد سهم درآمد برای محدوده درآمدی اول ۸۰.۵۵۵۵٪ و برای محدوده درآمدی دوم ۹۰.۵٪ است. سهم درآمد بر اساس قیمت خالص یک تراکنش محاسبه می‌شود. مبنای تجمیع ۱ ماه است. دوره قرارداد از ۱۵ سپتامبر ۲۰۱۳ آغاز می‌شود و پرداخت ظرف ۳۰ روز انجام می‌شود. (جزئیات مربوط به سهم درآمد هایلایت شده‌اند.)

$ 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"
}