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

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

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

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

پس‌از انتشار طرح نرخ، توسعه‌دهنده یا شرکت می‌تواند آن را با صدور درخواست POST به /mint/organizations/{org_name}/developers/{developer_or_company_id}/developer-rateplans خریداری (یا «قبول») کند، که در آن {org_name} نام سازمان و {developer_or_company_id} شناسه توسعه‌دهنده یا شرکت است.

برای صرف‌نظر کردن از کارمزدهای راه‌اندازی هنگام خرید طرح نرخ، پارامتر پُرسمان waivefees را روی true تنظیم کنید. این پرچم زمانی مفید است که درحال انتقال توسعه‌دهندگان به درآمدزایی هستید، همان‌طور که در انتقال توسعه‌دهندگان به درآمدزایی توضیح داده شده است.

جدول زیر خلاصه ویژگی‌های پیکربندی است که می‌توانید در بدنه درخواست مشخص کنید، مقادیر پیش‌فرض آن‌ها، و اینکه آیا الزامی هستند یا نه.

برای مثال، درخواست زیر طرح نرخ location_&_messaging را برای توسعه‌دهنده مشخص‌شده خریداری می‌کند:

curl "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/5cTWgdUvdr6JW3xU/developer-rateplans" \
  -X POST \
  -H "Content-Type:application/json" \
  -u email:password \
  -d '{
   "developer":{
     "id":"5cTWgdUvdr6JW3xU"
   },
   "startDate":"2017-08-30",
   "ratePlan":{
     "id":"location_&_messaging"
   },
   "suppressWarning":false
  }'

در این مثال، خصوصیت suppressWarning روی false تنظیم شده است. در این حالت، درصورت بروز تعارض، خطا ایجاد می‌شود. برای مثال، اگر توسعه‌دهنده سعی کند طرح نرخی را خریداری کند که با طرح نرخ خریداری‌شده دیگری هم‌پوشانی دارد، خطا ایجاد می‌شود. این کار به برنامه‌ای که میانای کاربری برای درآمدزایی ارائه می‌دهد امکان می‌دهد خطا را رهگیری کند و محصولات متعارض را برای تأیید به توسعه‌دهنده نمایش دهد (درصورت لزوم). اگر suppressWarning روی true تنظیم شود، درآمدزایی همه طرح‌های قیمت خریداری‌شده‌ای را که توسعه‌دهنده برای بسته‌های API حاوی محصولات متعارض دارد خاتمه می‌دهد. سپس بسته جدیدی از «میانای برنامه‌سازی کاربردی» را برای توسعه‌دهنده خریداری می‌کند.

درخواست زیر طرح نرخ اعلان قابل‌تنظیم را خریداری می‌کند و تعداد هدف تراکنش‌ها را روی ۴۰۰۰ تنظیم می‌کند.

curl "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/5cTWgdUvdr6JW3xU/developer-rateplans" \
  -X POST \
  -H "Content-Type:application/json" \
  -u email:password \
  -d '{
   "developer":{
     "id":"5cTWgdUvdr6JW3xU"
   },
   "ratePlan":{
     "id":"adjustable-notification-plan"
   },
   "startDate": "2017-03-24",
   "quotaTarget": 4000,
   "suppressWarning":false
  }'

در هریک از مثال‌های بالا، اگر پیام خطای زیر برگردانده شود:

Developer legal name not specified. 

سپس باید مشخصه‌های درآمدزایی MINT_DEVELOPER_ADDRESS و MINT_DEVELOPER_LEGAL_NAME را تنظیم کنید و سپس تماس با API را تکرار کنید.

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

برای منقضی کردن (یا لغو کردن) طرح قیمتی که توسعه‌دهنده خریداری کرده است، جزئیات طرح قیمت خریداری‌شده را به‌روز کنید و دارایی endDate را در بدنه درخواست در درخواست PUT به منبع /organizations/{org_name}/developers/{developer_or_company_id}/developer-rateplans/{developer_rateplan_id} مشخص کنید.

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

وقتی طرح نرخ منتشرشده را خریداری می‌کنید، {developer_rateplan_id} در پاسخ برگردانده می‌شود.

برای مثال:

{
  "created": "2017-03-31 18:59:54",
  "developer": {
    ...
  },
  "id": "b1c600b8-f871-496d-8173-12b9950d6ab1",
  "quotaTarget": 3000,
  "ratePlan": {
    ...
  },
  "startDate": "2017-03-31 00:00:00",
  "updated": "2017-03-31 18:59:54",
  "waiveTerminationCharge": false
}

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

درخواست زیر تاریخ پایان را به ۱ دسامبر ۲۰۱۷ به‌روز می‌کند. یعنی طرح نرخ در پایان روز ۳۰ نوامبر ۲۰۱۷ منقضی خواهد شد؛ همه درخواست‌های ۱ دسامبر ۲۰۱۷ مسدود خواهد شد.

curl "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans/b1c600b8-f871-496d-8173-12b9950d6ab1"
  -X PUT \
  -H "Content-Type:application/json" \
  -u email:password \
  -d '{
   "id" : "b1c600b8-f871-496d-8173-12b9950d6ab1",
   "developer":{
     "id":"dev@mycompany.com"
   },
   "ratePlan":{
     "id":"p1_adjustable-notification-plan"
   },
   "startDate": "2017-04-15 00:00:00",
   "endDate": "2017-11-30",
   "quotaTarget": 3000,
   "suppressWarning":false
  }'