پیکربندی طرح کارت نرخ

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

مقدمه

در طرح کارت نرخ، برای هر تراکنش از توسعه دهنده هزینه دریافت می شود. برای این نوع طرح، باید جزئیات بیشتری مانند مدل شارژ و قیمت مدل شارژ ارائه دهید.

به صورت اختیاری، می‌توانید یک طرح freemium را برای محصولات جداگانه (به جای یک بسته API) مشخص کنید - می‌توانید این کار را فقط برای یک برنامه خاص محصول انجام دهید.

چه زمانی کارمزدهای تکراری دریافت می‌شود و طرح‌های بسته بازنشانی می‌شوند؟

طرح‌های نرخ می‌توانند شامل کارمزدهای تکرارشونده و همچنین بسته‌های API (طرح‌های Volume Banded و Bundle) باشند، که هر دو شامل زمان‌های خاصی هستند که هزینه‌ها شارژ می‌شوند و طرح‌های بسته به صفر بازنشانی می‌شوند. جدول زیر زمان دریافت هزینه های تکرارشونده و بازنشانی تعداد بسته ها را توضیح می دهد. اگر برنامه‌های توسعه‌دهنده از برقراری تماس‌های API بیشتر مسدود شوند، زیرا به یک حد تراکنش معین رسیده‌اند، این زمان‌هایی است که تعداد تماس‌های API به صفر می‌رسد و برنامه‌ها می‌توانند دوباره برقراری تماس را آغاز کنند.

پیکربندی طرح‌های کارت نرخ با استفاده از رابط کاربری

برنامه های کارت نرخ را، همانطور که در زیر توضیح داده شده است، پیکربندی کنید.

پیکربندی طرح کارت نرخ با استفاده از API

جزئیات طرح کارت نرخ را با استفاده از API پیکربندی کنید، همانطور که در بخش های زیر توضیح داده شده است.

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

هنگام ایجاد طرح نرخ، جزئیات طرح کارت نرخ را مشخص می کنید. شما جزئیات را در ویژگی ratePlanDetails در بدن درخواست در یک تماس با /organizations/{org_name}/monetization-packages/{package_id}/rate-plans مشخص می‌کنید. آنچه در ویژگی ratePlanDetails مشخص می‌کنید، به مدل شارژی که انتخاب می‌کنید بستگی دارد: نرخ ثابت، حجم باند، یا بسته‌ها.

تعیین یک مدل شارژ با نرخ ثابت

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

• یک پارامتر رتبه‌بندی که نشان می‌دهد برنامه نرخ بر اساس تراکنش‌ها ( VOLUME ) یا بر اساس یک ویژگی سفارشی (مثلا MINT_CUSTOM_ATTRIBUTE_1 ) است. VOLUME پیش فرض است.
• یک نوع اندازه‌گیری ( UNIT ) که نشان می‌دهد نرخ برای هر واحد ثابت است (یعنی بر اساس حجم تراکنش‌ها نیست، همانطور که در مورد مدل شارژ باندی یا بسته‌ای است).
• دوره پرداخت (به عنوان مثال، 30 روز).
• شناسه سازمان شما
• "پایه" یا ارز حسابداری که شرکت شما استفاده می کند.
• نرخ طرح نرخ که جزئیاتی در مورد نحوه محاسبه نرخ ارائه می دهد. از آنجایی که مدل شارژ بر اساس نرخ ثابت است، شما فقط یک نرخ طرح نرخ را مشخص می‌کنید.

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

• نوع نرخ طرح نرخ ( RATECARD ).
• نرخ برای طرح به عنوان مثال، اگر 0.10 را مشخص کنید و واحد پول آن دلار آمریکا باشد، برای هر تراکنش 0.10 دلار از توسعه دهنده دریافت می شود (یا اگر بر اساس یک ویژگی سفارشی مانند تعداد بایت های ارسال شده در یک تراکنش، از توسعه دهنده 0.10 دلار برای انتقال هزینه دریافت می شود. تعداد بایت های مشخص شده).
• واحد شروع برنامه نرخ ( 0 ). این به این معنی است که نرخ برای هر تراکنش اعمال می شود و از اولین تراکنش شروع می شود.

برای لیست کاملی از گزینه های جزئیات طرح نرخ، تنظیمات پیکربندی جزئیات طرح نرخ را ببینید.

به عنوان مثال، موارد زیر یک طرح کارت نرخ با یک مدل شارژ ثابت ایجاد می کند. نرخ برای هر تراکنش 0.10 دلار تعیین شده است. پرداخت در 30 روز انجام می شود. (جزئیات مربوط به کارت نرخ برجسته شده است.)

curl -H "Content-Type:application/json" -X POST -d \
'{ 
     "name": "Flat rate card plan",
     "developer":null,
     "developerCategory":null,
     "advance": "false",
     "currency": {
      "id" : "usd"
     },     
     "description": "Flat rate card plan",
     "displayName" : "Flat rate card plan",
     "frequencyDuration": "30",
     "frequencyDurationType": "DAY",
     "earlyTerminationFee": "10",     
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },
     "paymentDueDays": "30",
     "prorate": "false",
     "published": "true",
     "ratePlanDetails": [
     {
      "currency": {
       "id" : "usd"
      },
      "paymentDueDays": "30",      
      "meteringType": "UNIT",
      "organization": {
       "id": "{org_name}"
      },
      "ratePlanRates": [
       {
        "type": "RATECARD",
        "rate": "0.10",
        "startUnit": "0"       
       }      
      ], 
     "ratingParameter": "VOLUME",
     "type": "RATECARD"
     }],
     "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

تعیین مدل شارژ باندی حجمی

در یک مدل باند حجمی، جزئیات طرح نرخ را مشخص می‌کنید که شامل یک یا چند نرخ طرح نرخ است، هر نرخ برای یک «باند حجمی»، یعنی محدوده‌ای از حجم تراکنش (یا محدوده‌ای بر اساس یک ویژگی سفارشی مانند تعداد بایت های ارسال شده). این نوع طرح معمولاً برای تشویق توسعه دهندگان به تولید حجم بالاتر با ارائه نرخ های تخفیف برای باندهای حجم بالاتر تنظیم می شود.

علاوه بر نرخ های طرح نرخ، موارد زیر را در جزئیات طرح نرخ مشخص می کنید:

• یک پارامتر رتبه‌بندی که نشان می‌دهد برنامه نرخ بر اساس تراکنش‌ها ( VOLUME ) یا بر اساس یک ویژگی سفارشی (مثلاً CUSTOM_ATTRIBUTE_1 ) است. VOLUME پیش فرض است.
• یک نوع اندازه‌گیری ( VOLUME ) که نشان می‌دهد نرخ بر اساس حجم تراکنش‌ها است (یعنی نرخ ثابتی برای هر تراکنش نیست، همانطور که در مورد مدل شارژ نرخ ثابت وجود دارد).
• دوره پرداخت (به عنوان مثال، 30 روز).
• شناسه سازمان شما
• "پایه" یا ارز حسابداری که شرکت شما استفاده می کند.
• یک نوع مدت و مدت زمان که با هم دوره زمانی را مشخص می کند که در آن حجم تراکنش ها (یا حجم مربوط به ویژگی سفارشی) جمع می شود. به این "مبنای تجمیع" نیز می گویند. حجم معاملات بر اساس تجمیع (مثلاً 1 ماه) جمع می شود تا باند حجمی قابل اجرا تعیین شود.
• شمارنده های تجمعی که برای تعیین باند حجمی قابل اجرا استفاده می شوند.

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

• نوع نرخ طرح نرخ ( RATECARD ).
• نرخ برای طرح به عنوان مثال، اگر 0.10 را مشخص کنید و واحد پول آن دلار آمریکا باشد، برای هر تراکنش 0.15 دلار از توسعه دهنده دریافت می شود (یا اگر بر اساس یک ویژگی سفارشی مانند تعداد بایت های ارسال شده در یک تراکنش، از توسعه دهنده 0.15 دلار برای انتقال هزینه دریافت می شود. تعداد بایت های مشخص شده).
• واحد شروع و پایان باند صدا. واحد شروع حد پایین باند ولوم را مشخص می کند و واحد پایانی حد بالایی باند صدا را مشخص می کند. به عنوان مثال، اگر یک واحد شروع 0 و یک واحد پایانی 1000 را مشخص کنید، باند حجمی تا 1000 تراکنش را در دوره تجمیع پوشش می دهد. اگر ارز دلار آمریکا باشد، دوره تجمیع 1 ماه است و نرخ 1000 تراکنش اول 0.15 است، توسعه دهنده 0.15 دلار به ازای هر تراکنش برای حداکثر 1000 تراکنش در ماه دریافت می کند.
  
  برای جزئیات بیشتر در مورد زمان بازنشانی بسته‌ها، ببینید چه زمانی هزینه‌های تکراری دریافت می‌شوند و طرح‌های بسته بازنشانی می‌شوند؟
  

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

برای لیست کاملی از گزینه های جزئیات طرح نرخ، تنظیمات پیکربندی جزئیات طرح نرخ را ببینید.

به عنوان مثال، موارد زیر یک طرح کارت نرخ با یک مدل شارژ باند حجمی ایجاد می کند. این نرخ برای 1000 تراکنش اول 0.15 دلار و برای تمام تراکنش های بیش از 1000 تراکنش 0.10 دلار تعیین شده است. مبنای تجمیع 1 ماه است. پرداخت در 30 روز انجام می شود. (جزئیات کارت نرخ برجسته شده است.)

curl -H "Content-Type:application/json" -X POST -d \

'{
     "name": "Volume banded rate card plan",
     "developer":null,
     "developerCategory":null,
     "currency": {
      "id" : "usd"
     },     
     "frequencyDuration": "30",
     "description": "Volume banded rate card plan",
     "displayName" : "Volume banded rate card plan",
     "frequencyDuration": "30",
     "frequencyDurationType": "DAY",
     "earlyTerminationFee": "10",
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },    
     "paymentDueDays": "30",
     "prorate": "false",
     "published": "true",
     "ratePlanDetails": [
     {
      "currency": {
       "id" : "usd"
      },
      "aggregateStandardCounters": true,
      "paymentDueDays": "30",
      "duration": "1",
      "durationType": "MONTH",
      "meteringType": "VOLUME",
      "organization": {
       "id": "{org_name}"
      },      
      "ratePlanRates": [
      {
       "type": "RATECARD",
       "rate": "0.15",
       "startUnit": "0",
       "endUnit": "1000"
      },
      {
       "type": "RATECARD",
       "rate": "0.10",
       "startUnit": "1000"      
      }
      ],     
     "ratingParameter": "VOLUME",
     "type": "RATECARD"
     }],
     "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

مشخص کردن مدل شارژ همراه

در یک مدل شارژ بسته‌ای، توسعه‌دهنده برای «بسته‌ای» از تراکنش‌ها (یا برای بسته‌ای بر اساس یک ویژگی سفارشی مانند تعداد بایت‌های ارسال شده) هزینه پرداخت می‌کند. شما نرخی را برای هر بسته و پایه های تجمیع مشخص می کنید، یعنی مدت زمانی که توسعه دهنده می تواند از بسته نرم افزاری استفاده کند.

به عنوان مثال، فرض کنید دو باندل تنظیم کرده اید، که اندازه بسته اول 1 تا 1000 تراکنش است و اندازه بسته دوم 1001 تا 2000 تراکنش است. نرخ برای بسته اول 50 دلار و برای بسته دوم 40 دلار است، و مبنای تجمیع 1 است. اگر توسعه‌دهنده یک طرح کارت نرخ برای بسته اول خریداری کند، 50 دلار (از قبل) برای 1000 تراکنش در ماه پرداخت می‌کند. مبلغ تعیین شده از برنامه‌نویس دریافت می‌شود، چه بسته نرم افزاری کاملاً استفاده شده باشد یا نه. پس از پایان دوره تجمیع، طرح منقضی می شود. اگر توسعه دهنده بخواهد دوباره از بسته نرم افزاری استفاده کند، باید طرح (و بسته نرم افزاری) را دوباره خریداری کند.

آنچه در جزئیات طرح نرخ مشخص می‌کنید اساساً همان چیزی است که در جزئیات طرح نرخ برای مدل شارژ باندی حجمی مشخص می‌کنید. تفاوت ها به شرح زیر است:

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

برای لیست کاملی از گزینه های جزئیات طرح نرخ، تنظیمات پیکربندی جزئیات طرح نرخ را ببینید.

به عنوان مثال، موارد زیر یک طرح کارت نرخ با یک مدل شارژ همراه ایجاد می کند. نرخ برای بسته اول 50 دلار (حداکثر 1000 تراکنش) و 40 دلار برای بسته دوم (بیش از 1000 و حداکثر 2000 تراکنش) تعیین شده است. مبنای تجمیع 1 ماه است. پرداخت در 30 روز انجام می شود.

curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Bundled rate plan",
     "developer":null,
     "developerCategory":null,
     "currency": {
      "id" : "usd"
     },    
     "frequencyDuration": "30",
     "description": "Bundled rate plan",
     "displayName" : "Bundled rate plan",
     "frequencyDurationType": "DAY",
     "earlyTerminationFee": "10",
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },    
     "paymentDueDays": "30",
     "prorate": "true",
     "published": "true",
     "ratePlanDetails": [
     {
      "currency": {
       "id" : "usd"
      },
      "aggregateStandardCounters": true,
      "paymentDueDays": "30",
      "duration": "1",
      "durationType": "MONTH",
      "meteringType": "STAIR_STEP",
      "organization": {
       "id": "{org_name}"
      },
      "ratePlanRates": [
      {
       "type": "RATECARD",
       "rate": "50",
       "startUnit": "0",
       "endUnit": "1000"
      },
      {
       "type": "RATECARD",
       "rate": "40",
       "startUnit": "1000",
       "endUnit": "2000"
      }
      ],
     "ratingParameter": "VOLUME",
     "type": "RATECARD"
     }],
     "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

تعیین یک طرح فریمیوم برای محصولات جداگانه با استفاده از API

در طرح کارت نرخ، می توانید یک طرح فریمیوم را برای یک محصول جداگانه (به جای یک بسته API) تنظیم کنید. یک طرح فریمیوم به توسعه دهندگان استفاده رایگان از یک محصول API را در مدت زمان معین یا بر اساس میزان استفاده ارائه می دهد.

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

• مدت زمان، یعنی زمان بین یک تاریخ موثر و یک تاریخ پایان.
• مقدار، مانند تعداد تراکنش های مربوط به محصول API یا حجم مربوط به یک ویژگی سفارشی ثبت شده در خط مشی ضبط تراکنش.

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

curl -H "Content-Type:application/json" -X POST -d \
'{
      "name": "Flat rate card plan with freemium period",
      "developer":null,
      "developerCategory":null,      
      "advance": "false",
      "currency": {
       "id" : "usd"
      },     
      "description": "Flat rate card plan with freemium period",
      "displayName" : "Flat rate card plan with freemium period",
      "frequencyDuration": "30",
      "frequencyDurationType": "DAY",
      "earlyTerminationFee": "10",     
      "monetizationPackage": {
       "id": "location"
      },
      "organization": {
       "id": "myorg"
      },
      "paymentDueDays": "30",
      "prorate": "false",
      "published": "false",
      "ratePlanDetails": [
      {
       "currency": {
       "aggregateFreemiumCounters" : true,
       "aggregateStandardCounters" : true,
        "id" : "usd"
       },
       "product" : {
        "id" : "location",
        "displayName":"Location"
       },
       "paymentDueDays": "30",      
       "meteringType": "UNIT",
       "organization": {
        "id": "myorg"
       },
       "ratePlanRates": [
        {
         "type": "RATECARD",
         "rate": "0.10",
         "startUnit": "0"       
        }      
       ],
      "freemiumUnit": "5000",
      "freemiumDuration": "0",
      "freemiumDurationType": "DAY",
      "ratingParameterUnit":"MB",
      "customPaymentTerm": "false",
      "ratingParameter": "VOLUME",
      "type": "RATECARD"
      }],
      "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