مدیریت دسته‌های محصول میانای برنامه‌سازی کاربردی

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

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

بسته محصول «میانای برنامه‌سازی کاربردی» چیست؟

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

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

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

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

حداقل و حداکثر قیمت در جزئیات بسته محصول API نمایش داده می‌شود.

کاوش صفحه «دسته‌های محصول»

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

افزودن بسته محصول

برای افزودن دسته محصول API:

1. در صفحه «بسته‌های محصول»، روی + بسته محصول API کلیک کنید.
2. نامی برای بسته محصول API وارد کنید.

3. نام محصول API را در فیلد «افزودن محصول» وارد کنید.

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

4. مرحله ۳ را تکرار کنید تا نام‌های محصول API بیشتری اضافه کنید.
5. برای هر محصول API که اضافه می‌کنید، خط‌مشی ضبط تراکنش را پیکربندی کنید.
6. روی ذخیره کردن دسته محصولات کلیک کنید.

ویرایش بسته محصول

برای ویرایش بسته محصول:

1. در صفحه دسته‌های محصول، در ردیف دسته محصولی که می‌خواهید ویرایش کنید کلیک کنید.

   پانل دسته محصول نمایش داده می‌شود.

2. فیلدهای دسته محصول را درصورت نیاز ویرایش کنید.

   برای اطلاعات بیشتر، پیکربندی خط‌مشی ضبط تراکنش را ببینید.

3. روی به‌روزرسانی دسته محصول کلیک کنید.

مدیریت کردن دسته‌های محصول «میانای برنامه‌سازی کاربردی» بااستفاده از «میانای برنامه‌سازی کاربردی»

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

ایجاد بسته محصول API بااستفاده از API

برای ایجاد یک بسته محصول API، یک درخواست POST به /organizations/{org_name}/monetization-packages ارسال کنید. وقتی درخواست را صادر می‌کنید، باید:

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

درصورت تمایل، می‌توانید سازمان را مشخص کنید.

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

برای مثال:

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "description": "payment messaging package",
     "displayName": "Payment Messaging Package",
     "name": "Payment Messaging Package",
     "organization": { "id": "{org_name}" },
     "product": [
       { "id": "messaging" },
       { "id": "payment" }
     ],
     "status": "CREATED"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages" \
-u email:password

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

{
   "description" : "payment messaging package",
   "displayName" : "Payment Messaging Package",
   "id" : "payment_messaging_package",
   "name" : "Payment Messaging Package",
   "organization" : {
     "id" : "{org_name}",
     "separateInvoiceForFees" : false
   },
   "product" : [ {
     "customAtt1Name" : "user",
     "description" : "Messaging",
     "displayName" : "Messaging",
     "id" : "messaging",
     "name" : "messaging",
     "organization" : {
       "id" : "{org_name}",
       "separateInvoiceForFees" : false
     },
     "status" : "CREATED"
   }, {
     "customAtt1Name" : "user",
     "description" : "Payment",
     "displayName" : "Payment",
     "id" : "payment",
     "name" : "payment",
     "organization" : {
       "id" : "{org_name}",
       "separateInvoiceForFees" : false
     },
     "status" : "CREATED"
   }],
   "status" : "CREATED"
 }

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

مدیریت محصولات میانای برنامه‌سازی کاربردی در بسته محصول میانای برنامه‌سازی کاربردی بااستفاده از میانای برنامه‌سازی کاربردی

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

افزودن محصول میانای برنامه‌سازی کاربردی به بسته محصول میانای برنامه‌سازی کاربردی

برای افزودن محصول API به بسته محصول API، درخواست POST را به organizations/{org_name}/monetization-packages/{package_id}/products/{product_id} ارسال کنید، که در آن {org_name} نام سازمان شما را مشخص می‌کند، {package_id} نام بسته محصول API را مشخص می‌کند، و {product_id} شناسه محصول API را مشخص می‌کند.

برای مثال:

$ curl -H "Accept:application/json" -X POST -d \
'{}'\
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/{package_id}/products/{product_id}" \
-u email:password

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

برای افزودن محصول API به بسته محصول API که یک یا چند طرح نرخ ویژه محصول API تعریف‌شده دارد (کارت نرخ یا سهم درآمد)، درخواست POST به organizations/{org_name}/monetization-packages/{package_id}/products/{product_id} ارسال کنید، که در آن {org_name} نام سازمان شما را مشخص می‌کند، {package_id} نام بسته محصول API را مشخص می‌کند، و {product_id} شناسه محصول API را مشخص می‌کند.

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

برای مثال:

$ curl -H "Content-Type:application/json" -X POST -d \
'{
    "ratePlan": [ 
        {
            "id": "mypackage_rateplan1",
            "ratePlanDetails": [
                {
                    "currency": {
                        "id": "usd"
                    },
                    "duration": 1,
                    "durationType": "MONTH",
                    "meteringType": "UNIT",
                    "organization" : {
                        "id": "{org_name}",
                    "paymentDueDays": "30",
                    "ratePlanRates": [
                        {
                            "rate": "1.99",
                            "startUnit": "0",
                            "type": "RATECARD"
                        }
                    ],
                    "ratingParameter": "VOLUME",
                    "type": "RATECARD"
                }
            ]
        }
    ]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/{package_id}/products/{product_id}" \
-u email:password

حذف محصول API از بسته محصول API

برای حذف محصول API از بسته محصول API، درخواست DELETE را به organizations/{org_name}/monetization-packages/{package_id}/products/{product_id} ارسال کنید، که در آن {org_name} نام سازمان شما، {package_id} نام بسته محصول API، و {product_id} شناسه محصول API را مشخص می‌کند.

برای مثال:

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

مشاهده دسته‌های محصول «میانای برنامه‌سازی کاربردی» بااستفاده از «میانای برنامه‌سازی کاربردی»

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

مشاهده بسته محصول میانای برنامه‌سازی کاربردی خاص: برای بازیابی بسته محصول میانای برنامه‌سازی کاربردی خاص، درخواست GET به /organizations/{org_name}/monetization-packages/{package_id} صادر کنید، در اینجا {package_id} شناسه بسته محصول میانای برنامه‌سازی کاربردی است (شناسه در پاسخ هنگام ایجاد بسته محصول میانای برنامه‌سازی کاربردی برگردانده می‌شود). برای مثال:

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

مشاهده همه بسته‌های محصول API: برای بازیابی همه بسته‌های محصول API برای یک سازمان، درخواست GET به /organizations/{org_name}/monetization-packages صادر کنید. برای مثال:

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

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

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

{
  "monetizationPackage" : [ {
    "description" : "payment messaging package",
    "displayName" : "Payment Messaging Package",
    "id" : "payment_messaging_package",
    "name" : "Payment Messaging Package",
    "organization" : {
      ...
    },
    "product" : [ {
      "customAtt1Name" : "user",
      "description" : "Messaging",
      "displayName" : "Messaging",
      "id" : "messaging",
      "name" : "messaging",
      "organization" : {
        ...
      },
      "status" : "CREATED"
    }, {
      "customAtt1Name" : "user",
      "description" : "Payment",
      "displayName" : "Payment",
      "id" : "payment",
      "name" : "payment",
      "organization" : {
        ...
      },
      "status" : "CREATED"
    } ],
    "status" : "CREATED"
  }, {
    "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"
  }, {
    "description" : "Payment",
    "displayName" : "Payment",
    "id" : "payment",
    "name" : "Payment",
    "organization" : {
     ...
    },
    "product" : [ {
      "customAtt1Name" : "user",
      "description" : "Payment",
      "displayName" : "Payment",
      "id" : "payment",
      "name" : "payment",
      "organization" : {
        ...
      },
      "status" : "CREATED"
    } ],
    "status" : "CREATED"
  } ],
  "totalRecords" : 3
}

مشاهده دسته‌های محصول API با تراکنش‌ها: برای بازیابی دسته‌های محصول API با تراکنش‌ها در محدوده تاریخ معین، درخواست GET به /organizations/{org_name}/packages-with-transactions صادر کنید. وقتی درخواست را صادر می‌کنید، باید تاریخ شروع و تاریخ پایان را برای محدوده تاریخ به‌عنوان پارامترهای پُرسمان مشخص کنید. برای مثال، درخواست زیر دسته‌های محصول API را با تراکنش‌های ماه اوت ۲۰۱۳ بازیابی می‌کند.

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/packages-with-transactions?START_DATE=2013-08-01&END_DATE=2013-08-31" \
-u email:password

پاسخ باید چیزی شبیه به این باشد (فقط بخشی از پاسخ نشان داده می‌شود):

{
  "monetizationPackage" : [ {
    "description" : "Payment Package",
    "displayName" : "Payment Package",
    "id" : "payment_package",
    "name" : "Payment Package",
    "organization" : {
      ...
    },
    "product" : [ {
      "customAtt1Name" : "user",
      "customAtt2Name" : "response size",
      "customAtt3Name" : "content-length",
      "description" : "payment api product",
      "displayName" : "payment",
      "id" : "payment",
      "name" : "payment",
      "organization" : {
        ...
      },
      "status" : "CREATED",
      "transactionSuccessCriteria" : "status == 'SUCCESS'"
    } ],
    "status" : "CREATED"
  }, {
    "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"
  },
     ...
  } ]
}

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

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

• ‫/organizations/{org_name}/developers/{developer_id}/monetization-packages، که در آن {developer_id} شناسه (نشانی ایمیل) توسعه‌دهنده است.
• ‫/organizations/{org_name}/companies/{company_id}/monetization-packages، که در آن {company_id} شناسه شرکت است.

هنگام صدور درخواست، می‌توانید به‌صورت اختیاری پارامترهای پُرسمان زیر را مشخص کنید:

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

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/dev1@myorg.com/monetization-packages" \
-u email:password

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

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/companies/myCompany/monetization-packages?current=true" \
-u email:password

حذف بسته محصول API بااستفاده از API

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

برای حذف کردن بسته محصول API که هیچ طرح نرخی برای آن تعریف نشده است، درخواست DELETE به organizations/{org_name}/monetization-packages/{package_id} ارسال کنید، که در آن {org_name} نام سازمان شما را مشخص می‌کند و {package_id} نام بسته محصول API را مشخص می‌کند.

برای مثال:

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

دارایی‌های پیکربندی بسته محصول «میانای برنامه‌سازی کاربردی» برای «میانای برنامه‌سازی کاربردی»

گزینه‌های پیکربندی بسته محصول API زیر درمعرض دید API قرار می‌گیرد: