شما در حال مشاهده مستندات Apigee Edge هستید.
به مستندات Apigee X مراجعه کنید . اطلاعات
مقدمه
در طرح کارت نرخ، برای هر تراکنش از توسعهدهنده هزینه دریافت میشود. برای این نوع طرح، باید جزئیات بیشتری مانند مدل دریافت هزینه و قیمتگذاری برای مدل دریافت هزینه ارائه دهید.
به صورت اختیاری، میتوانید یک طرح فریمیوم را برای محصولات جداگانه (به جای یک بسته API) مشخص کنید - میتوانید این کار را فقط برای یک طرح خاص برای محصول انجام دهید.
هزینههای دورهای چه زمانی دریافت و طرحهای بسته چه زمانی بازنشانی میشوند؟
طرحهای نرخگذاری میتوانند شامل هزینههای دورهای و همچنین بستههای API (طرحهای Volume Banded و Bundle) باشند که هر دو شامل زمانهای مشخصی هستند که در آنها هزینهها دریافت میشوند و طرحهای بسته به صفر بازنشانی میشوند. جدول زیر زمانهای دریافت هزینههای دورهای و بازنشانی تعداد بستهها را شرح میدهد. اگر برنامههای توسعهدهنده به دلیل رسیدن به یک حد تراکنش خاص، از برقراری تماسهای API بیشتر منع شوند، در این زمانها تعداد تماسهای API به صفر بازنشانی میشود و برنامهها میتوانند دوباره شروع به برقراری تماس کنند.
| اگر طرح دارای ... | ...این اتفاق میافتد |
|---|---|
| هزینه دورهای و بازنشانی طرح بسته در اول ماه (پیشفرض) انجام میشود. برای یک دوره بازگشت ماهانه در یک روز خاص، با استفاده از API مدیریت، یک طرح نرخ ایجاد کنید و روز را با ویژگی |
| هزینه دورهای و طرح بسته هر ۷ روز پس از تاریخ شروع طرح تعرفه توسعهدهنده، مجدداً تنظیم میشود. |
| هزینه دورهای و طرح بسته هر X روز پس از تاریخ شروع طرح تعرفه توسعهدهنده، مجدداً تنظیم میشود. |
| طرحهای بسته بر اساس مبنای تجمیع تعریفشده در کارت نرخ، بازنشانی میشوند. برای مثال، اگر یک توسعهدهنده طرح نرخ را در نوزدهم ماه شروع کند و مبنای تجمیع هر یک ماه باشد، استفاده از بسته هر ماه در نوزدهم بازنشانی میشود. توجه داشته باشید که ممکن است روز ماه همیشه یکسان نباشد. برای مثال، اگر یک طرح تعرفهای از ۳۱ دسامبر شروع شود، تاریخ بازنشانی در فوریهای که سال کبیسه ندارد، ۲۸ام میشود، زیرا فوریه فقط ۲۸ روز دارد. پس از آن، روز ۲۸ام به عنوان روز بازنشانی باقی میماند. |
پیکربندی طرحهای کارت نرخ با استفاده از رابط کاربری
طرحهای کارت نرخ را مطابق توضیحات زیر پیکربندی کنید.
لبه
برای پیکربندی طرح کارت نرخ، هنگام ایجاد یا ویرایش طرح نرخ، نوع طرح نرخ کارت نرخ یا کارت نرخ و سهم درآمد را انتخاب کنید و در بخش کارت نرخ یکی از مدلهای محاسبه زیر را انتخاب کنید:
| مدل شارژ | توضیحات |
| نرخ ثابت | برای هر تراکنش، نرخ ثابتی از توسعهدهنده دریافت میشود. |
| نوار حجمی | بسته به حجم تراکنشها، از توسعهدهنده نرخ متغیری دریافت میشود. |
| بستهها | برای هر بسته تراکنش، مبلغ مشخصی از توسعهدهنده پیشاپیش دریافت میشود. چه از کل بسته استفاده شود و چه نشود، مبلغ تعیینشده از توسعهدهنده دریافت میشود. توجه : این گزینه هنگام انتخاب کارت نرخ و سهم درآمد در دسترس نیست. |
سپس، اطلاعات زیر را بر اساس مدل شارژ انتخاب شده پیکربندی کنید.
| مدل شارژ | میدان | توضیحات |
| همه | فرکانس محاسبه | دوره زمانی که حجم تراکنشها (یا حجم مربوط به ویژگی سفارشی) در آن محاسبه میشود. تعداد ماهها (۱ تا ۲۴ ماه) را انتخاب کنید. |
| نرخ ثابت | نرخ ثابت | نرخ هر تراکنش. یک عدد اعشاری (تا چهار رقم اعشار) وارد کنید. توجه : میتوانید تعداد ارقام اعشاری که میتوان برای نرخ اعمال شده با استفاده از API (نه رابط کاربری) تعیین کرد را پیکربندی کنید. برای جزئیات بیشتر، به پیکربندی تعداد ارقام اعشار برای نرخهای طرح نرخ مراجعه کنید. برای مثال، اگر عدد 0.10 را وارد کنید و واحد پول دلار آمریکا باشد، برای هر تراکنش 0.10 دلار از توسعهدهنده کسر میشود (یا اگر بر اساس یک ویژگی سفارشی مانند تعداد بایتهای منتقلشده در یک تراکنش باشد، برای ارسال تعداد مشخصشده بایتها از توسعهدهنده 0.10 دلار کسر میشود). |
| نوار حجمی | باندهای حجمی | یک یا چند محدوده از حجم تراکنش (یا مبتنی بر ویژگی مشتری) (هر محدوده یک "باند حجمی" است) برای مدل محاسبه هزینه بر اساس حجم. به هر باند حجمی میتوان یک نرخ اختصاص داد. این نرخ برای همه تراکنشهای موجود در باند حجمی مربوطه اعمال میشود. حد بالای باند اول را مشخص کنید، مثلاً تا ۱۰۰۰ (حد پایین از پیش روی بیشتر از ۰ تنظیم شده است). برای افزودن باندهای بیشتر، روی +جدید کلیک کنید. حد بالایی باند نهایی را خالی بگذارید تا تمام تراکنشهای بالاتر از این سطح را نشان دهد. توجه : میتوانید تعداد ارقام اعشاری که میتوان برای نرخ اعمال شده با استفاده از API (نه رابط کاربری) تعیین کرد را پیکربندی کنید. برای جزئیات بیشتر، به پیکربندی تعداد ارقام اعشار برای نرخهای طرح نرخ مراجعه کنید. برای مثال، اگر در بخش «محدوده حجم» دو محدوده حجمی (بالای 0 تا 1000 و بالای 1000) مشخص کنید، میتوانید برای محدوده حجمی بالای 0 تا 1000 عدد 0.15 و برای محدوده حجمی بالای 1000 عدد 0.10 را وارد کنید. اگر ارز انتخابی دلار آمریکا باشد، نرخ برای 1000 تراکنش اول 0.15 دلار برای هر تراکنش و برای بیش از 1000 تراکنش، نرخ برای هر تراکنش 0.10 دلار است. |
| بستهها | قیمت بستههای API | تعداد تراکنشهای موجود در یک بسته (یا عددی مربوط به یک ویژگی سفارشی مانند تعداد کل بایتهای منتقل شده در یک بسته). به هر بسته میتوان یک قیمت اختصاص داد. این قیمت برای کل بسته اعمال میشود. حد بالای بسته اول را مشخص کنید، مثلاً تا ۱۰۰۰ (حد پایین از پیش روی بیشتر از ۰ تنظیم شده است). برای افزودن بستههای اضافی، روی +جدید کلیک کنید. شما باید برای آخرین بسته، یک حد بالا تعیین کنید، مگر اینکه بخواهید برای تراکنشهای نامحدود در آخرین بسته، مبلغ ثابتی را از توسعهدهنده دریافت کنید. توجه : میتوانید تعداد ارقام اعشاری که میتوان برای نرخ اعمال شده با استفاده از API (نه رابط کاربری) تعیین کرد را پیکربندی کنید. برای جزئیات بیشتر، به پیکربندی تعداد ارقام اعشار برای نرخهای طرح نرخ مراجعه کنید. برای مثال، اگر در بخش اندازه بسته، دو بسته (بزرگتر از 0 تا 1000 و بزرگتر از 1000 تا 2000) مشخص کنید، میتوانید برای بسته بزرگتر از 0 تا 1000 عدد 50 و برای بسته بزرگتر از 1000 تا 2000 عدد 40 را وارد کنید. اگر ارز انتخاب شده دلار آمریکا باشد، قیمت بسته اول 50 دلار و برای بسته دوم 40 دلار است. هزینه بسته مربوطه صرف نظر از تعداد تراکنشهای استفاده شده در بسته، از توسعهدهنده دریافت میشود (یعنی به محض تکمیل اولین تراکنش در بسته، هزینه بسته از توسعهدهنده دریافت میشود). |
اگر برای محصول API خود ویژگیهای سفارشی تعریف کردهاید، میتوانید یک پارامتر رتبهبندی سفارشی پیکربندی کنید تا از توسعهدهنده برنامه بر اساس یک ویژگی سفارشی در هر تراکنش هزینه دریافت شود. به عنوان مثال، اگر طرحی را تنظیم کردهاید که در آن برای هر تراکنش از توسعهدهنده هزینه دریافت میکنید، میتوانید نرخ طرح را بر اساس یک ویژگی سفارشی، مانند تعداد بایتهای منتقل شده در backend که میتواند در هر تراکنش متفاوت باشد، تعیین کنید.
در این حالت، گزینه «استفاده از پارامتر رتبهبندی سفارشی» را انتخاب کنید و ویژگی سفارشی را از لیست کشویی انتخاب کنید. برای اطلاعات بیشتر، به «پیکربندی طرح نرخ با ویژگیهای سفارشی» مراجعه کنید.
لبه کلاسیک (ابر خصوصی)
برای پیکربندی طرحهای کارت نرخ با استفاده از رابط کاربری کلاسیک اج:
- برای ایجاد یک طرح تعرفه، مراحل را دنبال کنید.
- برای پیکربندی مدل درآمد، از منوی کشویی نوع طرح نرخ ، کارت نرخ را انتخاب کنید.
- اگر بسته API انتخاب شده شامل چندین محصول API است، یکی از گزینههای زیر را انتخاب کنید:
توجه : اگر بسته API شامل یک محصول API واحد است، میتوانید از این مرحله صرف نظر کنید.
- طرحهای ویژه محصول برای پیکربندی جزئیات طرح نرخ برای هر محصول API به صورت جداگانه.
- طرح عمومی برای همه محصولات برای پیکربندی جزئیات طرح نرخ برای همه محصولات API.
- برای طرح نرخ عمومی یا برای هر طرح نرخ ویژه محصول API، روی کارت نرخ کلیک کنید.
توجه : هنگام پیکربندی طرحهای مختص محصول API، باید برای هر محصول API به صورت جداگانه یک طرح کارت نرخ پیکربندی کنید.
پنجره کارت امتیاز باز میشود.
- یک طرح فریمیوم برای یک محصول API تنظیم کنید. یک طرح فریمیوم به توسعهدهندگان امکان استفاده رایگان از یک محصول API را در یک دوره زمانی یا بر اساس میزان استفاده ارائه میدهد.
اطلاعات زیر را وارد کنید:
میدان توضیحات محصول فریمیوم؟ مدت زمان دوره رایگان. یکی از دکمههای رادیویی زیر را انتخاب کنید:
- بر اساس مقدار. دوره رایگان بر اساس مقدار مشخص شده در فیلد حجم محاسبه میشود.
- بر اساس مدت زمان. دوره هزینه بر اساس یک بازه زمانی مشخص شده در فیلد مدت زمان فریمیوم است.
- هر کدام که زودتر اتفاق بیفتد. دوره رایگان زمانی پایان مییابد که یا به مقدار موجود در فیلد حجم یا به بازه زمانی موجود در فیلد مدت زمان فریمیوم رسیده باشد، هر کدام که زودتر اتفاق بیفتد.
- نه. این یک طرح فریمیوم نیست. این طرح پیشفرض است.
حجم فریمیوم حجم تراکنشها (یا حجم مربوط به یک ویژگی سفارشی ثبتشده در سیاست ثبت تراکنش) که برای آن از توسعهدهندگان هزینهای دریافت نمیشود. این حجم برای محصول API اندازهگیری میشود. یک عدد حجم، مانند ۵۰۰۰، وارد کنید. این بدان معناست که وقتی توسعهدهندگان طرح را شروع میکنند، برای ۵۰۰۰ تراکنش اول (یا برای ۵۰۰۰ استفاده اول از یک آیتم مرتبط با ویژگی سفارشی) هزینهای از آنها دریافت نمیشود. این فیلد فقط در صورتی فعال میشود که در فیلد «محصول فریمیوم؟» گزینه «بر اساس تعداد» یا «هر کدام که زودتر اتفاق بیفتد» را انتخاب کنید.
مدت زمان فریمیوم بازه زمانی که در طول آن از توسعهدهندگان هزینهای دریافت نمیشود. یک عدد وارد کنید و یک دوره زمانی، مثلاً ۱ ماه، را انتخاب کنید. این بدان معناست که از توسعهدهندگان به مدت ۱ ماه هزینهای دریافت نمیشود. این فیلد فقط در صورتی فعال میشود که در فیلد «محصول فریمیوم؟» گزینه «بر اساس مدت زمان» یا «هر کدام که زودتر اتفاق بیفتد» را انتخاب کنید.
- یکی از مدلهای شارژ زیر را انتخاب کنید:
- نرخ ثابت. در این مدل، برای هر تراکنش، نرخ ثابتی از توسعهدهنده دریافت میشود.
- محدوده حجمی. در این مدل، بسته به حجم تراکنشها، نرخ متغیری از توسعهدهنده دریافت میشود.
- بستهها. در این مدل، برای هر بسته تراکنش، مبلغ مشخصی (از قبل) از توسعهدهنده دریافت میشود. چه بسته به طور کامل استفاده شود و چه نشود، مبلغ تعیینشده از توسعهدهنده دریافت میشود.
برای مدل نرخ ثابت: اطلاعات زیر را در بخش قیمتگذاری پنجره کارت نرخ عمومی وارد کنید:
میدان توضیحات اپراتور (یا سازمان) نام سازمان شما. این فیلد با استفاده از مقدار فیلد اپراتور (یا سازمان) در پروفایل سازمان از پیش تعیین شده است.
کشور کشور محل فعالیت سازمان شما. این فیلد با استفاده از مقدار فیلد کشور در پروفایل سازمان از پیش تعیین شده است.
نرخ ثابت نرخ هر تراکنش. یک عدد اعشاری (تا چهار رقم اعشار) وارد کنید.
توجه : میتوانید تعداد ارقام اعشاری که میتوان برای نرخ اعمال شده با استفاده از API (نه رابط کاربری) تعیین کرد را پیکربندی کنید. برای جزئیات بیشتر، به پیکربندی تعداد ارقام اعشار برای نرخهای طرح نرخ مراجعه کنید.
برای مثال، اگر عدد 0.10 را وارد کنید و واحد پول دلار آمریکا باشد، برای هر تراکنش 0.10 دلار از توسعهدهنده کسر میشود (یا اگر بر اساس یک ویژگی سفارشی مانند تعداد بایتهای منتقلشده در یک تراکنش باشد، برای ارسال تعداد مشخصشده بایتها از توسعهدهنده 0.10 دلار کسر میشود).
برای مدل نوار حجمی: پنجره کارت نرخ عمومی، فیلدهای اضافی را نمایش میدهد که شما برای تعیین مبنایی برای تجمیع و تعیین «نوارهای حجمی»، یعنی محدودههایی از حجم تراکنش که میتوانید نرخهای متفاوتی برای آنها اعمال کنید، استفاده میکنید.
این نوع طرح معمولاً برای تشویق توسعهدهندگان به تولید حجمهای بالاتر با ارائه نرخهای تخفیف برای باندهای حجمی بالاتر تنظیم میشود.
اطلاعات زیر را در پنجره Generic Rate Card وارد کنید:
میدان توضیحات مبنای تجمیع دوره زمانی که حجم تراکنشها (یا حجم مربوط به ویژگی سفارشی) تجمیع میشود. حجم تجمیعشده برای شناسایی محدوده حجم و نرخ اعمالشده برای هر تراکنش استفاده میشود. تعداد ماهها (۱ تا ۱۲ ماه) را انتخاب کنید.
برای جزئیات بیشتر در مورد زمان بازنشانی بستهها، به «چه زمانی هزینههای دورهای دریافت میشود و طرحهای بسته بازنشانی میشوند؟» مراجعه کنید.
باندهای حجمی یک یا چند محدوده از حجم تراکنش (یا مبتنی بر ویژگی مشتری) (هر محدوده یک "باند حجم" است). به هر باند حجم میتوان یک نرخ اختصاص داد (این نرخ را در فیلد باندهای حجم در بخش قیمتگذاری تنظیم میکنید.) این نرخ برای همه تراکنشهای موجود در باند حجم مربوطه اعمال میشود. حد بالای باند اول را مشخص کنید، مثلاً تا ۱۰۰۰ (حد پایین از پیش روی بزرگتر از ۰ تنظیم شده است). برای اضافه کردن باند دوم، مثلاً بزرگتر از ۱۰۰۰ تا ۲۰۰۰، روی + کلیک کنید. برای اضافه کردن باندهای بیشتر، روی + کلیک کنید. میتوانید حد بالای باند نهایی را خالی بگذارید تا همه تراکنشهای بالاتر از این سطح را نشان دهد.
قیمتگذاری اپراتور (یا سازمان) نام سازمان شما. این فیلد با استفاده از مقدار فیلد اپراتور (یا سازمان) در نمایه سازمان از پیش تعیین شده است.
کشور کشور محل فعالیت سازمان شما. این فیلد با استفاده از مقدار فیلد کشور در نمایه سازمان از پیش تعیین شده است.
ارز واحد پول "پایه" یا حسابداری که سازمان شما استفاده میکند. این فیلد با استفاده از مقدار فیلد واحد پول در نمایه سازمان از پیش تعیین شده است، اما میتوان آن را در اینجا تغییر داد.
باندهای حجمی نرخ برای یک باند حجمی. شما برای هر باند حجمی یک نرخ تعیین میکنید. برای هر باند یک عدد اعشاری (تا چهار رقم اعشار) وارد کنید.
توجه : میتوانید تعداد ارقام اعشاری که میتوان برای نرخ باند حجمی مشخص کرد را با استفاده از API (نه رابط کاربری) پیکربندی کنید. برای جزئیات بیشتر، به پیکربندی تعداد ارقام اعشار برای نرخهای طرح نرخ مراجعه کنید.
برای مثال، اگر در بخش «محدوده حجم» دو محدوده حجمی (بالای 0 تا 1000 و بالای 1000) مشخص کنید، میتوانید برای محدوده حجمی بالای 0 تا 1000 عدد 0.15 و برای محدوده حجمی بالای 1000 عدد 0.10 را وارد کنید. اگر ارز انتخابی دلار آمریکا باشد، نرخ برای 1000 تراکنش اول 0.15 دلار برای هر تراکنش و برای بیش از 1000 تراکنش، نرخ برای هر تراکنش 0.10 دلار است.
برای مدل بستهای: پنجرهی کارت نرخ عمومی، فیلدهای اضافی را نمایش میدهد که شما برای تعیین مبنایی برای تجمیع (دورهی زمانی که توسعهدهنده میتواند از بستهی تراکنشها استفاده کند) و تعیین اطلاعات مربوط به بسته، مانند اندازهی یک بسته، از آنها استفاده میکنید.
اطلاعات زیر را در پنجره Generic Rate Card وارد کنید:
میدان توضیحات مبنای تجمیع مدت زمانی که توسعهدهنده میتواند از بسته تراکنشها استفاده کند (یا از یک بسته سفارشی مبتنی بر ویژگی استفاده کند). تعداد ماهها (۱ تا ۱۲ ماه) را انتخاب کنید. پس از این مدت، طرح منقضی میشود و توسعهدهنده باید دوباره طرح (و بستهها) را خریداری کند.
برای جزئیات بیشتر در مورد زمان بازنشانی بستهها، به «چه زمانی هزینههای دورهای دریافت میشود و طرحهای بسته بازنشانی میشوند؟» مراجعه کنید.
اندازه بسته تعداد تراکنشهای موجود در یک بسته (یا عددی مربوط به یک ویژگی سفارشی مانند تعداد کل بایتهای منتقل شده در یک بسته). به هر بسته میتوان قیمتی اختصاص داد (این قیمت را میتوانید در فیلد اندازه بسته در بخش قیمتگذاری تعیین کنید.) این قیمت برای کل بسته اعمال میشود. حد بالای بسته اول را مشخص کنید، مثلاً تا ۱۰۰۰ (حد پایین از پیش روی بیشتر از ۰ تنظیم شده است). برای اضافه کردن بسته دوم، مثلاً بیشتر از ۱۰۰۰ تا ۲۰۰۰، روی + کلیک کنید. برای اضافه کردن بستههای بیشتر، روی + کلیک کنید. باید برای آخرین بسته یک حد بالا تعیین کنید، مگر اینکه بخواهید برای تراکنشهای نامحدود در آخرین بسته، مبلغ ثابتی را از توسعهدهنده دریافت کنید.
قیمتگذاری اپراتور (یا سازمان) نام سازمان شما. این فیلد با استفاده از مقدار فیلد اپراتور (یا سازمان) در نمایه سازمان از پیش تعیین شده است.
کشور کشور محل فعالیت سازمان شما. این فیلد با استفاده از مقدار فیلد کشور در نمایه سازمان از پیش تعیین شده است.
ارز واحد پول "پایه" یا حسابداری که سازمان شما استفاده میکند. این فیلد با استفاده از مقدار فیلد واحد پول در نمایه سازمان از پیش تعیین شده است، اما میتوان آن را در اینجا تغییر داد.
اندازه بسته (قیمت) قیمت یک بسته. شما برای هر بسته قیمتی تعیین میکنید. یک عدد اعشاری (تا چهار رقم اعشار) وارد کنید.
توجه : میتوانید تعداد ارقام اعشاری که میتوان برای نرخ بسته مشخص کرد را با استفاده از API (نه رابط کاربری) پیکربندی کنید. برای جزئیات بیشتر، به پیکربندی تعداد ارقام اعشار برای نرخهای طرح نرخ مراجعه کنید.
برای مثال، اگر در بخش اندازه بسته، دو بسته (بزرگتر از 0 تا 1000 و بزرگتر از 1000 تا 2000) مشخص کنید، میتوانید برای بسته بزرگتر از 0 تا 1000 عدد 50 و برای بسته بزرگتر از 1000 تا 2000 عدد 40 را وارد کنید. اگر ارز انتخاب شده دلار آمریکا باشد، قیمت بسته اول 50 دلار و برای بسته دوم 40 دلار است. هزینه بسته مربوطه صرف نظر از تعداد تراکنشهای استفاده شده در بسته، از توسعهدهنده دریافت میشود (یعنی به محض تکمیل اولین تراکنش در بسته، هزینه بسته از توسعهدهنده دریافت میشود).
- برای ذخیره جزئیات کارت نرخ و بازگشت به پنجره طرح نرخ استاندارد ، روی اعمال و بستن کلیک کنید.
- برای طرحهای نرخ ویژه محصول 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 روز).
- شناسه سازمان شما.
- «پایه» یا واحد پول حسابداری که شرکت شما از آن استفاده میکند.
- یک مدت زمان و نوع مدت زمان که با هم دوره زمانی را که حجم تراکنشها (یا حجم مربوط به ویژگی سفارشی) در آن تجمیع میشود، مشخص میکنند. این همچنین "مبنای تجمیع" نامیده میشود. حجم تراکنشها بر اساس مبنای تجمیع (به عنوان مثال، ۱ ماه) تجمیع میشود تا محدوده حجمی قابل اجرا تعیین شود.
- شمارندههای تجمیع که برای تعیین باند حجمی قابل اجرا استفاده میشوند.
برای هر نرخ طرح نرخ، شما مشخص میکنید:
- نوع نرخ طرح نرخ (
RATECARD). - نرخ طرح. به عنوان مثال، اگر شما 0.10 را تعیین کنید و واحد پول دلار آمریکا باشد، برای هر تراکنش 0.15 دلار از توسعهدهنده هزینه دریافت میشود (یا اگر بر اساس یک ویژگی سفارشی مانند تعداد بایتهای منتقل شده در یک تراکنش باشد، برای ارسال تعداد مشخص شده بایت از توسعهدهنده 0.15 دلار هزینه دریافت میشود).
- واحد شروع و پایان باند حجم. واحد شروع، حد پایین باند حجم و واحد پایان، حد بالای باند حجم را مشخص میکند. برای مثال، اگر واحد شروع ۰ و واحد پایان ۱۰۰۰ را مشخص کنید، باند حجم تا ۱۰۰۰ تراکنش را در دوره تجمیع پوشش میدهد. اگر ارز دلار آمریکا باشد، دوره تجمیع ۱ ماه است و نرخ ۱۰۰۰ تراکنش اول ۰.۱۵ است، از توسعهدهنده ۰.۱۵ دلار برای هر تراکنش تا ۱۰۰۰ تراکنش در ماه کسر میشود.
برای جزئیات بیشتر در مورد زمان بازنشانی بستهها، به «چه زمانی هزینههای دورهای دریافت میشود و طرحهای بسته بازنشانی میشوند؟» مراجعه کنید.اگر واحد پایانی برای باند حجم نهایی مشخص نکنید، نرخ آن باند برای همه تراکنشها پس از اینکه تعداد تراکنشها از واحد شروع برای آن باند بیشتر شد، اعمال میشود. به عنوان مثال، اگر واحد شروع برای آخرین باند ۱۰۰۰ باشد و شما واحد پایانی برای آن باند مشخص نکنید، نرخ باند برای همه تراکنشها پس از ۱۰۰۰ تراکنش در دوره تجمیع اعمال میشود.
برای مشاهده لیست کاملی از گزینههای جزئیات طرح نرخ، به تنظیمات پیکربندی جزئیات طرح نرخ مراجعه کنید.
برای مثال، در ادامه یک طرح کارت نرخ با مدل محاسبهی حجم تراکنش ایجاد شده است. نرخ برای ۱۰۰۰ تراکنش اول ۰.۱۵ دلار و برای تمام تراکنشهای بالای ۱۰۰۰ تراکنش ۰.۱۰ دلار تعیین شده است. مبنای تجمیع ۱ ماه است. پرداخت ظرف ۳۰ روز انجام میشود. (جزئیات کارت نرخ با رنگهای هایلایت مشخص شده است.)
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
مشخص کردن مدل شارژ همراه
در مدل هزینهگیری بستهای، توسعهدهنده (از قبل) برای یک «بسته» از تراکنشها (یا برای یک بسته بر اساس یک ویژگی سفارشی مانند تعداد بایتهای منتقلشده) هزینه پرداخت میکند. شما برای هر بسته یک نرخ و یک مبنای تجمیع، یعنی یک دوره زمانی که توسعهدهنده میتواند از بسته استفاده کند، تعیین میکنید.
برای مثال، فرض کنید دو بسته تنظیم کردهاید که اندازه بسته اول ۱ تا ۱۰۰۰ تراکنش و اندازه بسته دوم ۱۰۰۱ تا ۲۰۰۰ تراکنش است. نرخ برای بسته اول ۵۰ دلار و برای بسته دوم ۴۰ دلار است و مبنای تجمیع ۱ است. اگر توسعهدهنده یک طرح کارت نرخ برای بسته اول خریداری کند، برای ۱۰۰۰ تراکنش در ماه ۵۰ دلار (از قبل) پرداخت میکند. چه بسته به طور کامل استفاده شود و چه نشود، مبلغ تعیینشده از توسعهدهنده کسر میشود. پس از پایان دوره تجمیع، طرح منقضی میشود. اگر توسعهدهنده بخواهد دوباره از بسته استفاده کند، باید دوباره طرح (و بسته) را خریداری کند.
آنچه در جزئیات طرح نرخ مشخص میکنید، اساساً همان چیزی است که در جزئیات طرح نرخ برای مدل شارژ با محدودیت حجمی مشخص میکنید. تفاوتها به شرح زیر است:
- هر طرح تعرفهای که مشخص میکنید برای یک بسته (به جای یک باند حجمی) است.
- شما باید برای آخرین بسته، یک سقف مشخص کنید، مگر اینکه بخواهید برای تراکنشهای نامحدود در آخرین بسته، مبلغ ثابتی را از توسعهدهنده دریافت کنید.
برای مشاهده لیست کاملی از گزینههای جزئیات طرح نرخ، به تنظیمات پیکربندی جزئیات طرح نرخ مراجعه کنید.
برای مثال، در ادامه یک طرح کارت نرخ با مدل شارژ بستهای ایجاد میشود. نرخ برای بسته اول (تا ۱۰۰۰ تراکنش) ۵۰ دلار و برای بسته دوم (بیش از ۱۰۰۰ و تا ۲۰۰۰ تراکنش) ۴۰ دلار تعیین شده است. مبنای تجمیع ۱ ماه است. پرداخت ظرف ۳۰ روز انجام میشود.
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 یا حجم مربوط به یک ویژگی سفارشی ثبت شده در سیاست ثبت تراکنش.
اگر دوره فریمیوم بر اساس کمیت است، آن را به صورت تعدادی از واحدهای فریمیوم مشخص کنید. برای مثال، کد زیر یک طرح کارت نرخ با یک طرح فریمیوم بر اساس حجم ۵۰۰۰ واحد ایجاد میکند (مشخصات مربوط به فریمیوم هایلایت شدهاند.)
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