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

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

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

بررسی صفحه طرح‌های نرخ

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

لبه

برای مشاهده طرح‌های نرخ‌گذاری در رابط کاربری Edge، به صفحه طرح‌های نرخ‌گذاری مراجعه کنید:

  1. وارد apigee.com/edge شوید.
  2. در نوار ناوبری سمت چپ، گزینه انتشار > کسب درآمد > نرخ‌گذاری طرح‌ها را انتخاب کنید.

صفحه طرح‌های تعرفه نمایش داده می‌شود.

همانطور که در شکل مشخص شده است، صفحه طرح‌های نرخ به شما امکان می‌دهد:

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

برای مشاهده طرح‌های نرخ با استفاده از رابط کاربری کلاسیک اج، به صفحه بسته‌های API دسترسی پیدا کنید:

  1. وارد آدرس http:// ms-ip :9000 شوید، که در آن ms-ip آدرس IP یا نام DNS گره سرور مدیریت است.
  2. در نوار ناوبری بالا، گزینه انتشار > بسته‌ها را انتخاب کنید.

صفحه بسته‌های API، طرح‌های نرخ تعریف‌شده برای هر بسته را نمایش می‌دهد.

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

ایجاد طرح تعرفه گذاری

برای ایجاد یک طرح تعرفه:

  1. به صفحه طرح‌های نرخ دسترسی پیدا کنید .
  2. روی +طرح نرخ کلیک کنید.
  3. فیلدهای زیر را در پنل بالا پیکربندی کنید:
    میدان توضیحات پیش‌فرض مورد نیاز
    نام طرح نرخ نام طرح تعرفه شما.

    نکته : نام باید در یک بسته محصول API منحصر به فرد باشد. دو طرح در یک بسته محصول نمی‌توانند نام یکسانی داشته باشند.

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

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

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

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

    		 همه خیر
    تاریخ شروع تاریخ شروع طرح تعرفه. تاریخ شروع را وارد کنید یا با استفاده از تقویم، یک تاریخ انتخاب کنید. امروز خیر
    تاریخ پایان تاریخ پایان طرح تعرفه. برای تعیین تاریخ پایان، گزینه « تاریخ پایان دارد» را فعال کنید، کلید را تغییر دهید و تاریخ پایان را وارد کنید یا با استفاده از تقویم، تاریخ را انتخاب کنید.

    توجه : طرح تعرفه تا پایان روز در تاریخ مشخص شده معتبر خواهد بود. برای مثال، اگر می‌خواهید یک طرح تعرفه را در ۱ دسامبر ۲۰۱۸ منقضی کنید، باید مقدار endDate را روی ۲۰۱۸-۱۱-۳۰ تنظیم کنید. در این صورت، طرح تعرفه در پایان روز ۳۰ نوامبر ۲۰۱۸ منقضی می‌شود؛ تمام درخواست‌های ۱ دسامبر ۲۰۱۸ مسدود خواهند شد.

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

    توجه : مطمئن شوید که تمام محصولات موجود در بسته محصول را پیکربندی کرده‌اید.

    		 ناموجود
  6. جزئیات طرح نرخ را بر اساس نوع طرح نرخ انتخاب شده پیکربندی کنید:
  7. روی یکی از موارد زیر کلیک کنید:
    دکمه توضیحات
    ذخیره به عنوان پیش‌نویس طرح تعرفه را به عنوان پیش نویس ذخیره کنید.

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

    انتشار طرح جدید طرح را منتشر کنید.

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

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

ویرایش طرح تعرفه

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

برای ویرایش طرح تعرفه:

  1. به صفحه طرح‌های نرخ دسترسی پیدا کنید .
  2. در ردیف طرح تعرفه‌ای که می‌خواهید ویرایش کنید، کلیک کنید.
    پنل طرح تعرفه نمایش داده می‌شود.
  3. در صورت نیاز، فیلدهای طرح نرخ را ویرایش کنید.
    توجه : پس از انتشار طرح تعرفه، فقط در صورتی می‌توانید تاریخ پایان را تغییر دهید که از قبل تعیین نشده باشد.
  4. روی یکی از موارد زیر کلیک کنید:
    دکمه توضیحات
    به‌روزرسانی پیش‌نویس (پیش‌نویس طرح‌های نرخ) طرح تعرفه را به عنوان پیش نویس ذخیره کنید.

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

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

    توجه : پس از تعیین تاریخ پایان برای طرح نرخ منتشر شده، دیگر نمی‌توان آن را تغییر داد.

حذف پیش‌نویس طرح تعرفه

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

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

برای حذف پیش‌نویس طرح تعرفه:

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

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

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

ایجاد طرح‌های نرخ با استفاده از API

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

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

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

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

اگر برای یک بسته محصول 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 به بسته محصول API my-package ، باید جزئیات طرح نرخ را برای محصول 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