برنامه های نرخ خرید با استفاده از 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 که حاوی محصولات متناقض هستند، خاتمه می‌دهد. سپس یک بسته API جدید برای توسعه دهنده خریداری می کند.

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

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} مشخص کنید. منبع /organizations/{org_name}/developers/{developer_or_company_id}/developer-rateplans/{developer_rateplan_id} .

طرح نرخ تا پایان روز در تاریخ پایان مشخص شده قابل اجرا خواهد بود. برای مثال، اگر می‌خواهید یک طرح نرخ را در 1 دسامبر 2017 منقضی کنید، باید مقدار پایان تاریخ را روی 2017-11-30 تنظیم کنید. در این صورت، طرح نرخ در پایان روز 30 نوامبر 2017 منقضی می شود. همه درخواست ها در تاریخ 1 دسامبر 2017 مسدود خواهند شد.

وقتی طرح نرخ منتشر شده را خریداری می‌کنید {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_id} ایمیل است {developer-rateplan-id} برای طرح نرخ توسعه‌دهنده دریافت کنید. آدرس توسعه دهنده برای اطلاعات بیشتر، مشاهده همه طرح‌های نرخ خریداری شده توسط یک برنامه‌نویس را ببینید.

درخواست زیر تاریخ پایان را به 1 دسامبر 2017 به روز می کند. یعنی طرح نرخ در پایان روز 30 نوامبر 2017 منقضی می شود. همه درخواست ها در تاریخ 1 دسامبر 2017 مسدود خواهند شد.

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
  }'