مدیریت برنامه های نرخ

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

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

کاوش در صفحه طرح های نرخ

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

ایجاد طرح نرخ

برای ایجاد یک طرح نرخ:

1. به صفحه Rate Plans دسترسی پیدا کنید .
2. روی +Rate Plan کلیک کنید.
3. فیلدهای زیر را در پنل بالا پیکربندی کنید:
   

   میدان	توضیحات	پیش فرض	مورد نیاز
   نام طرح نرخ گذاری	نام طرح نرخ شما توجه : نام باید در بسته محصول API منحصر به فرد باشد. دو طرح در یک بسته محصول نمی توانند نام یکسانی داشته باشند.	N/A	بله
   نوع طرح نرخ گذاری	نوع طرح نرخ گذاری یک مقدار را از لیست کشویی انتخاب کنید. برای فهرستی از انواع طرح نرخ معتبر، انواع طرح نرخ پشتیبانی شده را ببینید.	N/A	بله
   بسته محصول	بسته محصول API. یک مقدار را از لیست کشویی انتخاب کنید. برای اطلاعات بیشتر درباره بسته‌های محصول API، به مدیریت بسته‌های محصول API مراجعه کنید. اگر بسته محصولی را انتخاب کنید که حاوی بیش از یک محصول API است، باید انتخاب کنید که آیا برنامه‌های نرخ جداگانه برای هر محصول API پیکربندی شود یا یک طرح نرخ عمومی که برای همه محصولات API اعمال شود.	N/A	بله
   مخاطب	مخاطبانی که می توانند به طرح نرخ دسترسی داشته باشند. یکی از مقادیر زیر را از لیست کشویی انتخاب کنید: همه - همه توسعه دهندگان. توسعه دهنده - توسعه دهنده یا شرکت. نام توسعه دهنده یا شرکت را وارد کنید. همانطور که شما تایپ می کنید، لیستی از توسعه دهندگان/شرکت هایی که حاوی رشته هستند به صورت کشویی نمایش داده می شود. از لیست کشویی روی نام توسعه دهنده یا شرکت کلیک کنید. دسته برنامه نویس - دسته برنامه نویس. دسته توسعه دهنده را از لیست کشویی انتخاب کنید. دسته‌های برنامه‌نویس را طبق نیاز پیکربندی کنید، همانطور که در مدیریت دسته‌های توسعه‌دهنده توضیح داده شده است.	همه	خیر
   تاریخ شروع	تاریخ اجرایی شدن طرح نرخ تاریخ شروع را وارد کنید یا با استفاده از تقویم تاریخی را انتخاب کنید.	امروز	خیر
   تاریخ پایان	تاریخ پایان طرح نرخ برای تعیین تاریخ پایان، تاریخ پایان را فعال کنید، سوئیچ را تغییر دهید و تاریخ پایان را وارد کنید یا با استفاده از تقویم یک تاریخ را انتخاب کنید. توجه : طرح نرخ تا پایان روز در تاریخ مشخص شده قابل اجرا خواهد بود. برای مثال، اگر می‌خواهید یک طرح نرخ را در 1 دسامبر 2018 منقضی کنید، باید مقدار endDate را روی 2018-11-30 تنظیم کنید. در این صورت، طرح نرخ در پایان روز 30 نوامبر 2018 منقضی می شود. همه درخواست ها در تاریخ 1 دسامبر 2018 مسدود خواهند شد.	هیچ کدام	خیر
   قابل مشاهده برای پورتال ها	تنظیم کنید که طرح نرخ عمومی یا خصوصی باشد. به طرح‌های نرخ عمومی در مقابل خصوصی مراجعه کنید.	فعال شد	خیر

4. هزینه ها را برای طرح نرخ پیکربندی کنید. به پیکربندی هزینه‌ها برای طرح نرخ رجوع کنید.
   توجه : برای برنامه های اطلاع رسانی قابل تنظیم قابل اجرا نیست.
5. اگر بسته محصولی را انتخاب می‌کنید که حاوی بیش از یک محصول API است، تنظیمات برگزیده زیر را در بخش طرح نرخ خاص یا عمومی تنظیم کنید:
   توجه : این مرحله برای برنامه های اعلان قابل تنظیم قابل اجرا نیست.
   

   میدان	توضیحات	پیش فرض
   هر محصول را به صورت جداگانه پیکربندی کنید	پرچمی که مشخص می کند برای هر محصول API یک طرح نرخ جداگانه پیکربندی شود یا خیر.	از کار افتاده است
   پیشنهاد فریمیوم هر محصول را به صورت جداگانه پیکربندی کنید	پرچمی که مشخص می‌کند برای هر محصول API یک طرح فریمیوم پیکربندی شود یا خیر.	از کار افتاده است
   یک محصول را انتخاب کنید	اگر یک یا هر دو پرچم را فعال کنید، باید هر محصول را به صورت جداگانه از لیست کشویی انتخاب کنید و جزئیات طرح نرخ آن را پیکربندی کنید. توجه : مطمئن شوید که تمام محصولات موجود در بسته محصول را پیکربندی کرده اید.	N/A

6. بر اساس نوع طرح نرخ انتخاب شده، جزئیات طرح نرخ را پیکربندی کنید:
   
   • فریمیوم
   • کارت امتیاز
   • سهم درآمد
   • اعلان قابل تنظیم
7. یکی از موارد زیر را کلیک کنید:
   

   دکمه	توضیحات
   ذخیره به عنوان پیش نویس	برنامه نرخ را به عنوان پیش نویس ذخیره کنید. طرح نرخ تا زمانی که آن را منتشر نکنید برای توسعه دهندگان برنامه قابل مشاهده نخواهد بود. می‌توانید هر فیلدی را در طرح نرخ پیش‌نویس ویرایش کنید.
   انتشار طرح جدید	طرح را منتشر کنید. توجه : پس از انتشار یک طرح نرخ، فقط در صورتی می توانید تاریخ پایان را تغییر دهید که قبلاً تنظیم نشده باشد. نمی‌توانید یک طرح نرخ را پس از انتشار حذف کنید، اما می‌توانید طرح نرخ را منقضی کنید و آن را با یک طرح نرخ آتی جایگزین کنید، همانطور که در Expire a Experied rate plan توضیح داده شده است.

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

ویرایش طرح نرخ

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

برای ویرایش طرح نرخ:

1. به صفحه Rate Plans دسترسی پیدا کنید .
2. در ردیف طرح نرخی که می‌خواهید ویرایش کنید، کلیک کنید.
   پانل طرح نرخ نمایش داده می شود.
3. فیلدهای طرح نرخ را در صورت لزوم ویرایش کنید.
   توجه : پس از انتشار یک طرح نرخ، فقط در صورتی می توانید تاریخ پایان را تغییر دهید که قبلاً تنظیم نشده باشد.
4. یکی از موارد زیر را کلیک کنید:

   دکمه	توضیحات
   به‌روزرسانی پیش‌نویس (طرح‌های نرخ پیش‌نویس)	برنامه نرخ را به عنوان پیش نویس ذخیره کنید. طرح نرخ تا زمانی که آن را منتشر نکنید برای توسعه دهندگان برنامه قابل مشاهده نخواهد بود. می‌توانید هر فیلدی را در طرح نرخ پیش‌نویس ویرایش کنید.
   انتشار پیش‌نویس (طرح‌های نرخ پیش‌نویس)	طرح نرخ را منتشر کنید. توجه : پس از انتشار یک طرح نرخ، فقط در صورتی می توانید تاریخ پایان را تغییر دهید که قبلاً تنظیم نشده باشد. نمی‌توانید یک طرح نرخ را پس از انتشار حذف کنید، اما می‌توانید طرح نرخ را منقضی کنید و آن را با یک طرح نرخ آتی جایگزین کنید، همانطور که در Expire a Experied rate plan توضیح داده شده است.
   تاریخ پایان به‌روزرسانی (طرح‌های نرخ منتشر شده)	تاریخ پایان یک طرح منتشر شده را تعیین کنید. توجه : پس از تعیین تاریخ پایان برای یک طرح نرخ منتشر شده، دیگر نمی توان آن را تغییر داد.

حذف پیش نویس طرح نرخ

اگر دیگر نیازی به طرح نرخ پیش‌نویس نیست، آن را حذف کنید.

توجه: نمی توانید یک طرح نرخ منتشر شده را حذف کنید.

برای حذف یک طرح نرخ پیش‌نویس:

1. به صفحه Rate Plans دسترسی پیدا کنید .
2. مکان نما خود را روی طرح نرخی که می خواهید حذف کنید قرار دهید تا منوی اقدامات نمایش داده شود.
3. کلیک کنید .
4. برای تایید عمل روی Delete کلیک کنید.

مدیریت برنامه های نرخ با استفاده از API

بخش‌های زیر نحوه مدیریت برنامه‌های نرخ را با استفاده از API شرح می‌دهند.

ایجاد برنامه های نرخ با استفاده از API

برای ایجاد یک طرح نرخ، یک درخواست POST به /organizations/{org_name}/monetization-packages/{monetizationpackage_id}/rate-plans صادر کنید، جایی که {monetizationpackage_id} شناسه بسته محصول API است که برای آن طرح نرخ ایجاد می‌کنید ( هنگامی که بسته محصول API را ایجاد می کنید، شناسه در پاسخ بازگردانده می شود.

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

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

تنظیمات دیگری نیز وجود دارد که می توانید به صورت اختیاری تعیین کنید، مانند مدت زمان پرداخت (به عنوان مثال، 30 روز). ویژگی های پیکربندی را برای برنامه های نرخ رجوع کنید.

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

بخش‌های زیر نحوه ایجاد طرح‌های نرخ را شرح می‌دهند:

• ایجاد یک برنامه نرخ استاندارد با استفاده از API
• ایجاد یک برنامه نرخ توسعه دهنده یا شرکت با استفاده از API
• ایجاد یک برنامه نرخ طبقه بندی توسعه دهنده با استفاده از API
• ایجاد یک برنامه نرخ ویژه محصول API با استفاده از API
• تنظیم طرح نرخ به عنوان عمومی یا خصوصی با استفاده از API

ایجاد یک برنامه نرخ استاندارد با استفاده از API

برای ایجاد یک طرح نرخ استاندارد، همانطور که در مثال زیر نشان داده شده است، ویژگی type را روی STANDARD قرار دهید.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Simple rate plan",
     "currency": {
      "id" : "usd"
     },
     "description": "Simple rate plan",
     "displayName" : "Simple rate plan",
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },
     "published": true,
     "isPrivate" : false,
     "ratePlanDetails": [
     {
      …
     }
     ],
     "startDate": "2013-09-15",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location_package/rate-plans" \
-u email:password

ایجاد یک برنامه نرخ توسعه دهنده یا شرکت با استفاده از API

برای اعمال طرح نرخ برای یک توسعه دهنده یا شرکت خاص، مقدار type را روی Developer تنظیم کنید. همچنین باید توسعه‌دهنده یا شرکت را در درخواست شناسایی کنید، شناسه، نام قانونی و نام توسعه‌دهنده شرکت را مشخص کنید.

به عنوان مثال، گزیده زیر یک برنامه نرخ برای توسعه دهنده Dev Five ایجاد می کند:

...
     "type": "DEVELOPER",
       "developer" : {
        "id" : "0mkKu1PALUGfjUph",
        "legalName" : "DEV FIVE",
        "name" : "Dev Five"
      }
...

ایجاد یک برنامه نرخ طبقه بندی توسعه دهنده با استفاده از API

برای اعمال طرح نرخ برای یک دسته برنامه‌نویس، مقدار type را روی Developer_Category تنظیم کنید. همچنین باید دسته توسعه دهنده را در درخواست شناسایی کنید. به عنوان مثال:

...
     "type": "DEVELOPER_CATEGORY",
       "developerCategory" : {
        "id" : "5e172299-8232-45f9-ac46-40076139f373",
        "name" : "Silver",
        "description" : "Silver category"
      }
...

ایجاد یک برنامه نرخ ویژه محصول API با استفاده از API

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

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

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Multi-product rate plan",
     "currency": {
      "id" : "usd"
     },
     "description": "Multi-product rate plan",
     "displayName" : "Multi-product rate plan",
     "monetizationPackage": {
      "id": "mypackage",
      ...
     },
     "organization": {
      "id": "{org_name}",
      ...
     },
     "published": true,
     "isPrivate" : false,
     "ratePlanDetails": [
     {
        "ratePlanRates":[{
            "revshare":0,
            "startUnit":0,
            "type":"REVSHARE",
            "endUnit":null
        }],
       "revenueType":"NET",
       "type":"REVSHARE"
       "currency":{...},
       "product":{"id":"product1","displayName":"Product1"},
       "customPaymentTerm":false
     },
     {
        "ratePlanRates":[{
            "revshare":10,
            "startUnit":0,
            "type":"REVSHARE",
            "endUnit":null
        }],
       "revenueType":"NET",
       "type":"REVSHARE"
       "currency":{...},
       "product":{"id":"product2","displayName":"Product2"},
       "customPaymentTerm":false
     }
     ],
     "startDate": "2019-09-15",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/my-package/rate-plans" \
-u email:password

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

$ curl -H "Content-Type:application/json" -X POST -d \
'{
    "ratePlan": [
    {
        "id": "my-package_multi-product-rate-plan",
        "ratePlanDetails": [
        {
            "ratePlanRates":[{
                "revshare":20,
                "startUnit":0,
                "type":"REVSHARE",
                "endUnit":null
             }],
             "revenueType":"NET",
             "type":"REVSHARE"
             "currency":{...},
             "customPaymentTerm":false
         }]
    }]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/my-package/products/product3" \
-u email:password

تنظیم طرح نرخ به عنوان عمومی یا خصوصی با استفاده از API

هنگام ایجاد یک طرح نرخ، می توانید با استفاده از ویژگی isPrivate در بدنه درخواست، عمومی یا خصوصی بودن آن را مشخص کنید. اگر روی true تنظیم شود، طرح نرخ خصوصی خواهد بود. برای اطلاعات بیشتر، به طرح‌های نرخ عمومی در مقابل خصوصی مراجعه کنید.

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

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Simple rate plan",
     "currency": {
      "id" : "usd"
     },
     "description": "Simple rate plan",
     "displayName" : "Simple rate plan",
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },
     "published": true,
     "isPrivate" : true,
     "ratePlanDetails": [
     {
      …
     }
     ],
     "startDate": "2013-09-15",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location_package/rate-plans" \
-u email:password