مدیریت طرح‌های قیمت

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

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

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

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

درحال ایجاد طرح نرخ

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

برای ایجاد طرح نرخ، درخواست POST را به /organizations/{org_name}/monetization-packages/{monetizationpackage_id}/rate-plans ارسال کنید، که در آن {monetizationpackage_id} شناسه بسته محصول 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

انتشار طرح نرخ بااستفاده از API

برای انتشار طرح نرخ، مقدار دارایی published را هنگام ایجاد طرح نرخ روی درست تنظیم کنید. توسعه‌دهندگان می‌توانند طرح نرخ را از تاریخ مشخص‌شده در دارایی startDate برای طرح مشاهده کنند.

برای مثال، دستور زیر طرح کارت نرخ را ایجاد و منتشر می‌کند (فقط بخشی از درخواست نشان داده می‌شود):

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Flat rate card plan",
     "developer":null,
     "developerCategory":null,
     "advance": "false",
     …
     "published": "true",
     "ratePlanDetails": [
     …
      ],
     …
     "type": "RATECARD"
     }],
     …
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

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

برای ذخیره کردن طرح نرخ بدون انتشار آن، مقدار دارایی published را هنگام ایجاد طرح نرخ روی false تنظیم کنید.

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

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Flat rate card plan",
     "developer":null,
     "developerCategory":null,
     "advance": "false",
     …
     "published": "false",
     "ratePlanDetails": [
     …
      ],
     …
     "type": "RATECARD"
     }],
     …
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

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

برای به‌روزرسانی پیش‌نویس طرح نرخ، درخواست PUT به /organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_Id} ارسال کنید، که در آن{package_id} شناسه بسته API و {plan_Id} شناسه طرح نرخ است. وقتی به‌روزرسانی را انجام می‌دهید، باید تنظیمات به‌روزشده و شناسه طرح نرخ را در بدنه درخواست مشخص کنید. اگر نرخ طرح نرخ را به‌روزرسانی می‌کنید، باید شناسه نرخ طرح نرخ را نیز مشخص کنید. برای مثال، درخواست زیر نرخ طرح نرخ را در طرح نرخی که شناسه آن location_flat_rate_card_plan است به‌روزرسانی می‌کند (به‌روزرسانی برجسته شده است):

$ curl -H "Content-Type: application/json" -X PUT -d \
 '{
      "id" : "location_flat_rate_card_plan",
      "name": "Flat rate card plan",
      "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": "false",
      "ratePlanDetails": [
      {
       "currency": {
        "id" : "usd"
       },
       "paymentDueDays": "30",
       "meteringType": "UNIT",
       "organization": {
        "id": "{org_name}"
       },
       "ratePlanRates": [
        {
         "id" : "26b69b0b-9863-48c9-ba73-74a5b918fcec",
         "type": "RATECARD",
         "rate": "0.15",
         "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/location_flat_rate_card_plan" \
-u email:password

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

…
"ratePlanRates" : [ {
  "id" : "26b69b0b-9863-48c9-ba73-74a5b918fcec",
  "rate" : 0.15,
  "startUnit" : 0,
  "type" : "RATECARD"
} ],
…

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

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

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

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

برای مشاهده همه طرح‌های نرخ سازمان، درخواست GET را به /mint/organizations/{org_name}/rate-plans, صادر کنید که در آن {org_name} نام سازمان شما است.

می‌توانید پارامترهای پُرسمان زیر را برای فیلتر کردن نتایج ارسال کنید:

برای مثال:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/rate-plans" \
  -u email:password

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

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

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

• طرح‌های نرخ پیش‌نویس یا منقضی‌شده، پارامتر پُرسمان current را روی false (برای مثال، ?current=false) تنظیم کنید.
• طرح‌های نرخ خصوصی، پارامتر پُرسمان showPrivate را روی true تنظیم کنید (برای نمونه، ?showPrivate=true).
• همه طرح‌های نرخ استاندارد، پارامتر پُرسمان standard را روی true تنظیم کنید (برای نمونه، ?standard=true).

برای مثال:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/communications/rate-plans" \
  -u email:password

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

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

برای مثال:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/communications/rate-plans/communications_standard_fixed_plan" \
  -u email:password

در زیر نمونه‌ای از پاسخ ارائه شده است:

{
   "advance" : true,
   "contractDuration" : 1,
   "contractDurationType" : "YEAR",
   "currency" : {
     "id" : "usd",
     ...
     "organization" : {
       ...
     },
     ...
   },
   "description" : "Standard Fixed Plan",
   "displayName" : "Standard Fixed Plan",
   "earlyTerminationFee" : 0.0000,
   "frequencyDuration" : 1,
   "frequencyDurationType" : "MONTH",
   "id" : "communications_standard_fixed_plan",
   "isPrivate" : false,
   "monetizationPackage" : {
     "description" : "Communications",
     "displayName" : "Communications",
     "id" : "communications",
     "name" : "Communications",
     "organization" : {
      ...
     },
     "product" : [ {
       "customAtt1Name" : "user",
       "description" : "Location",
       "displayName" : "Location",
       "id" : "location",
       "name" : "location",
       "organization" : {
       ...
       },
       "status" : "CREATED"
     }, {
       "customAtt1Name" : "user",
       "description" : "Messaging",
       "displayName" : "Messaging",
       "id" : "messaging",
       "name" : "messaging",
       "organization" : {
         ...
       },
       "status" : "CREATED"
     } ],
     "status" : "CREATED"
   },
   "name" : "Standard Fixed Plan",
   "organization" : {
     ...
   },
   "paymentDueDays" : "30",
   "prorate" : true,
   "published" : true,
   "ratePlanDetails" : [ {
     "aggregateFreemiumCounters" : true,
     "aggregateStandardCounters" : true,
     "currency" : {
       "id" : "usd",
       "name" : "USD",
       "organization" : {
        ...
       },
       "status" : "ACTIVE",
       "virtualCurrency" : false
     },
     "id" : "cb92f7f3-7331-446f-ad63-3e176ad06a86",
     "meteringType" : "UNIT",
     "organization" : {
      ...
     },
     "paymentDueDays" : "30",
     "ratePlanRates" : [ {
       "id" : "07eefdfb-4db5-47f6-b182-5d606c6051c2",
       "rate" : 0.0500,
       "startUnit" : 0,
       "type" : "RATECARD"
     } ],
     "ratingParameter" : "VOLUME",
     "type" : "RATECARD"
   } ],
   "recurringFee" : 200.0000,
   "recurringStartUnit" : 1,
   "recurringType" : "CALENDAR",
   "setUpFee" : 100.0000,
   "startDate" : "2013-01-11 22:00:00",
   "type" : "STANDARD"
 }

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

برای مشاهده همه طرح‌های نرخ فعال برای یک توسعه‌دهنده، درخواست GET را به /mint/organizations/{org_name}/developers/{developer_id}/developer-rateplans ارسال کنید، که در آن {developer_id} نشانی ایمیل توسعه‌دهنده است.

می‌توانید پارامترهای پُرسمان زیر را برای فیلتر کردن نتایج ارسال کنید:

برای مثال:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans" \
  -u email:password

در زیر نمونه‌ای از پاسخ ارائه شده است:

{
  "ratePlan" : [ {
    "advance" : true,
    "contractDuration" : 1,
    "contractDurationType" : "MONTH",
    "currency" : {
      "description" : "United States Dollar",
      "displayName" : "United States Dollar",
      "id" : "usd",
      "name" : "USD",
      "organization" : {
        ...
      },
      "status" : "ACTIVE",
      "virtualCurrency" : false
    },
    "description" : "Fee Only RatePlan",
    "displayName" : "Fee Only RatePlan",
    "earlyTerminationFee" : 10.0000,
    "freemiumDuration" : 0,
    "freemiumDurationType" : "MONTH",
    "freemiumUnit" : 0,
    "frequencyDuration" : 1,
    "frequencyDurationType" : "WEEK",
    "id" : "messaging_package_fee_only_rateplan",
    "isPrivate" : false,
    "monetizationPackage" : {
      "description" : "messaging package",
      "displayName" : "Messaging Package",
      "id" : "messaging_package",
      "name" : "Messaging Package",
      "organization" : {
        ...
      },
      "product" : [ {
        "customAtt1Name" : "user",
        "customAtt2Name" : "response size",
        "customAtt3Name" : "content-length",
        "description" : "messaging api product",
        "displayName" : "messaging",
        "id" : "messaging",
        "name" : "messaging",
        "organization" : {
         ...
        },
        "status" : "CREATED",
        "transactionSuccessCriteria" : "status == 'SUCCESS'"
      } ],
      "status" : "CREATED"
    },
    "name" : "Fee Only RatePlan",
    "organization" : {
     ...
    },
    "paymentDueDays" : "30",
    "prorate" : false,
    "published" : true,
    "ratePlanDetails" : [ ],
    "recurringFee" : 10.0000,
    "recurringStartUnit" : 1,
    "recurringType" : "CALENDAR",
    "setUpFee" : 20.0000,
    "startDate" : "2013-02-20 00:00:00",
    "type" : "STANDARD"
  } ],
  "totalRecords" : 1
}

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

برای مشاهده طرح نرخ فعال یک توسعه‌دهنده، درخواست GET را به /mint/organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id} ارسال کنید، که در آن {developer_id} نشانی ایمیل توسعه‌دهنده است و {developer_rateplan_id} شناسه طرح نرخ پذیرفته‌شده‌ای است که وقتی طرح نرخ منتشرشده را می‌پذیرید در پاسخ برگردانده می‌شود.

برای مثال:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans/messaging_package_fee_only_rateplan" \
  -u email:password

در زیر نمونه‌ای از پاسخ ارائه شده است:

{
    "created" : "2018-01-25 20:01:54",
    "developer" : {
    },
    "id" : "a73s104-276f-45b3-8075-83d1046ea550",
    "nextCycleStartDate" : "2018-02-19 00:00:00",
    "nextRecurringFeeDate" : "2018-02-19 00:00:00",
    "prevRecurringFeeDate" : "2018-01-25 00:00:00",
    "ratePlan" : {
      "frequencyDuration" : 1,
      "frequencyDurationType" : "MONTH",
      "recurringFee" : 0.0000,
      "recurringStartUnit" : 19,
      "recurringType" : "CALENDAR",
      "setUpFee" : 0.0000,
      "type" : "STANDARD"
    },
    "startDate" : "2018-01-25 20:01:54",
    "updated" : "2018-01-25 20:01:54"
  }

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

برای مشاهده طرح نرخ پذیرفته‌شده برای توسعه‌دهنده‌ای که حاوی محصول میانای برنامه‌سازی کاربردی است، درخواست GET به /mint/organizations/{org_id}/developers/{developer_id}/products/{product_id}/rate-plan-by-developer-product ارسال کنید، که در آن {developer_id} شناسه توسعه‌دهنده و /{product_id} شناسه محصول است.

به‌طور پیش‌فرض، فقط طرح نرخ عمومی در نتایج برگردانده می‌شود. برای نمایش طرح نرخ خصوصی، پارامتر پُرسمان showPrivate را روی true تنظیم کنید (برای نمونه، ?showPrivate=true).

برای مثال:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/products/location/rate-plan-by-developer-product" \
  -u email:password

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

برای مشاهده طرح‌های نرخ که توسط توسعه‌دهنده پذیرفته شده است، درخواست GET را به /mint/organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans, صادر کنید، که در آن {developer_id} شناسه توسعه‌دهنده است.

می‌توانید پارامترهای پُرسمان زیر را برای فیلتر کردن نتایج ارسال کنید:

برای مثال:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-accepted-rateplans" \
  -u email:password

در زیر نمونه‌ای از پاسخ ارائه شده است:

{
  "developerRatePlan" : [ {
     "created" : "2018-01-25 20:01:54",
     "developer" : { ...
     },
     "id" : "a73s104-276f-45b3-8075-83d1046ea550",
     "nextCycleStartDate" : "2018-02-19 00:00:00",
     "nextRecurringFeeDate" : "2018-02-19 00:00:00",
     "prevRecurringFeeDate" : "2018-01-25 00:00:00",
     "ratePlan" : {
       "frequencyDuration" : 1,
       "frequencyDurationType" : "MONTH",
       "recurringFee" : 0.0000,
       "recurringStartUnit" : 19,
       "recurringType" : "CALENDAR",
       "setUpFee" : 0.0000,
       "type" : "STANDARD"
     },
     "startDate" : "2018-01-25 20:01:54",
     "updated" : "2018-01-25 20:01:54"
   }],
   "totalRecords" : 1
}

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

برای حذف پیش‌نویس طرح نرخ، درخواست DELETE را به /organizations/{org_name}/monetization-packages/package_id}/rate-plans/{plan_Id} ارسال کنید، که در آن {plan_Id} شناسه طرح نرخ برای حذف شدن است و {package_id} شناسه بسته API برای طرح نرخ است. برای مثال:

$ curl -H "Accept:application/json" -X DELETE \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans/location_flat_rate_card_plan" \
-u email:password

ویژگی‌های پیکربندی برای طرح‌های قیمت

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

دارایی‌های پیکربندی برای جزئیات طرح قیمت

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