إدارة حِزم منتجات واجهة برمجة التطبيقات

أنت تعرض مستندات Apigee Edge.
انتقل إلى مستندات Apigee X. معلومات

ادمِج منتجًا واحدًا أو أكثر من منتجات واجهة برمجة التطبيقات في حاوية واحدة يتم تحقيق الربح منها، ويُشار إليها باسم حزمة منتجات واجهة برمجة التطبيقات، كما هو موضّح في الأقسام التالية.

ما هي حزمة منتجات واجهة برمجة التطبيقات؟

حزمة منتجات واجهة برمجة التطبيقات هي مجموعة من منتجات واجهة برمجة التطبيقات يتم تقديمها للمطوّرين كمجموعة، وترتبط عادةً بخطة أسعار واحدة أو أكثر لتحقيق الربح. يمكنك إنشاء حِزم منتجات متعددة ضمن واجهة برمجة التطبيقات وتضمين منتج واحد أو أكثر من منتجات واجهة برمجة التطبيقات في كلّ حِزم. يمكنك وضع المنتج نفسه أو المنتجات نفسها من واجهة برمجة التطبيقات في حِزم مختلفة وربطها بخطط أسعار مختلفة (أو بخطط أسعار مختلفة).

ولا يمكن للمطوّرين تسجيل تطبيقاتهم لاستخدام حزمة منتجات من واجهة برمجة التطبيقات إلا من خلال شراء إحدى خطط الأسعار السارية حاليًا. لا تظهر حزمة المنتجات من واجهة برمجة التطبيقات للمطوّرين إلى أن تضيف خطة أسعار لحِزمة المنتجات وتنشرها (كعلنية). (بتاريخ بدء للتاريخ الحالي أو بتاريخ مستقبلي)، كما هو موضّح في إدارة خطط الأسعار. بعد إضافة خطة أسعار ونشرها، سيتمكّن المطوّرون الذين يسجّلون الدخول إلى بوابة المطوّرين من اختيار حزمة المنتجات من واجهة برمجة التطبيقات. واختر خطة الأسعار. ويمكنك بدلاً من ذلك قبول خطة أسعار لمطوّر برامج باستخدام واجهة برمجة تطبيقات الإدارة. لمزيد من المعلومات، يُرجى الاطّلاع على مقالة شراء خطط الأسعار المنشورة باستخدام واجهة برمجة التطبيقات.

بعد إضافة منتج واجهة برمجة التطبيقات إلى حزمة منتج واجهة برمجة التطبيقات، قد تحتاج إلى إعداد نقاط السعر منتج واجهة برمجة التطبيقات. عليك إجراء ذلك فقط في حال استيفاء جميع الشروط التالية:

• يمكنك إعداد خطة لمعدّل مشاركة الأرباح لمنتج واجهة برمجة التطبيقات.
• يحصّل المطورون رسومًا من الجهات الخارجية مقابل استخدام الموارد في منتج واجهة برمجة التطبيقات.
• هناك حد أدنى أو أقصى من القيود المفروضة على المبلغ الذي يمكن للمطوّرين تحصيله، وتريد إبلاغ المطوّرين بهذه القيود.

يتم عرض الحد الأدنى والأقصى للأسعار في تفاصيل حزمة منتجات واجهة برمجة التطبيقات.

استكشاف صفحة حِزم المنتجات

يمكنك الوصول إلى صفحة حِزم المنتجات، كما هو موضَّح أدناه.

إضافة حزمة منتجات

لإضافة حزمة منتجات من واجهة برمجة التطبيقات:

1. انقر على + حزمة منتجات من واجهة برمجة التطبيقات في صفحة حِزم المنتجات.
2. أدخِل اسمًا لحزمة منتجات واجهة برمجة التطبيقات.

3. أدخِل اسم منتج واجهة برمجة التطبيقات في الحقل "إضافة منتج".

   أثناء كتابة اسم منتج واجهة برمجة التطبيقات، تظهر قائمة بمنتجات واجهة برمجة التطبيقات التي تحتوي على السلسلة في قائمة منسدلة. انقر على اسم منتج واجهة برمجة التطبيقات لإضافته إلى الحزمة. كرِّر هذه الخطوات لإضافة منتجات أخرى من واجهة برمجة التطبيقات.

4. كرِّر الخطوة 3 لإضافة أسماء منتجات أخرى في واجهة برمجة التطبيقات.
5. لكل منتج تضيفه لواجهة برمجة التطبيقات، عليك ضبط سياسة تسجيل المعاملات.
6. انقر على حفظ حزمة المنتجات.

تعديل حزمة منتج

لتعديل حزمة منتجات:

1. في صفحة حِزم المنتجات، انقر على صف حِزمة المنتجات التي تريد تعديلها.

   يتم عرض لوحة حِزمة المنتج.

2. عدِّل حقول حزمة المنتجات على النحو المطلوب.

   راجع ضبط سياسة تسجيل المعاملات للحصول على مزيد من المعلومات.

3. انقر على تعديل حزمة المنتجات.

إدارة حِزم المنتجات في واجهة برمجة التطبيقات باستخدام واجهة برمجة التطبيقات

توضّح الأقسام التالية كيفية إدارة حِزم المنتجات في واجهة برمجة التطبيقات باستخدام واجهة برمجة التطبيقات.

إنشاء حزمة منتج واجهة برمجة التطبيقات باستخدام واجهة برمجة التطبيقات

لإنشاء حزمة منتجات من واجهة برمجة التطبيقات، عليك إرسال طلب POST إلى /organizations/{org_name}/monetization-packages عند إصدار الطلب، يجب:

• يمكنك تحديد منتجات واجهة برمجة التطبيقات التي يجب تضمينها في حزمة منتجات واجهة برمجة التطبيقات.
• حدِّد اسمًا ووصفًا لحزمة منتج واجهة برمجة التطبيقات.
• يمكنك ضبط مؤشر حالة لحزمة منتجات واجهة برمجة التطبيقات. يمكن أن يحتوي مؤشر الحالة على أحد القيم التالية: CREATED وACTIVE وINACTIVE. حاليًا، تمثل قيمة مؤشر الحالة التي تحددها في حزمة منتج واجهة برمجة التطبيقات، ولكن لا يتم استخدامها لأي غرض.

يمكنك تحديد المؤسسة، إذا أردت.

راجِع خصائص ضبط حزمة منتجات واجهة برمجة التطبيقات للحصول على قائمة بالخيارات المعروضة. واجهة برمجة التطبيقات.

على سبيل المثال:

$ 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"
 }

لاحِظ أنّ الردّ يتضمن معلومات إضافية حول منتجات واجهة برمجة التطبيقات وأي معلومات مخصّصة المحددة لمنتجات واجهة برمجة التطبيقات هذه. (يتم تحديد السمات المخصصة عند إنشاء منتج واجهة برمجة التطبيقات). يمكن تضمين السمات المخصّصة لمنتج واجهة برمجة التطبيقات في خطط الأسعار المختلفة. بالنسبة إذا أعددت خطة بطاقة أسعار، وتقوم بتحصيل رسوم من المطوّر مقابل كل معاملة، يجب يمكنها ضبط معدل الخطة استنادًا إلى سمة مخصّصة مثل عدد وحدات البايت المنقولة في معاملة.

إدارة منتجات واجهة برمجة التطبيقات في حزمة منتجات لواجهة برمجة التطبيقات باستخدام واجهة برمجة التطبيقات

يمكنك إضافة منتج واجهة برمجة التطبيقات أو حذفه من حزمة منتجات ضمن واجهة برمجة التطبيقات باستخدام واجهة برمجة التطبيقات، كما هو موضّح في الأقسام التالية.

إضافة منتج واجهة برمجة التطبيقات إلى حزمة منتجات ضمن واجهة برمجة التطبيقات

لإضافة منتج واجهة برمجة التطبيقات إلى حزمة منتجات واجهة برمجة التطبيقات، عليك إرسال طلب POST إلى organizations/{org_name}/monetization-packages/{package_id}/products/{product_id}, حيث يحدّد {org_name} اسم مؤسستك، {package_id} تحدّد اسم حزمة منتجات واجهة برمجة التطبيقات، ويحدّد {product_id} معرّف واجهة برمجة التطبيقات المنتج.

على سبيل المثال:

$ 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

إضافة منتج واجهة برمجة التطبيقات إلى حزمة منتج واجهة برمجة التطبيقات باستخدام واجهة برمجة التطبيقات خطط الأسعار الخاصة بالمنتج

لإضافة منتج واجهة برمجة التطبيقات إلى حزمة منتج واجهة برمجة تطبيقات تحتوي على خطة أسعار واحدة أو أكثر خاصة بمنتج واجهة برمجة التطبيقات محددة (بطاقة السعر أو حصة الأرباح)، وإصدار طلب POST إلى organizations/{org_name}/monetization-packages/{package_id}/products/{product_id}, حيث يحدّد {org_name} اسم مؤسستك، {package_id} تحدّد اسم حزمة منتجات واجهة برمجة التطبيقات، ويحدّد {product_id} معرّف واجهة برمجة التطبيقات المنتج.

يجب ضبط تفاصيل خطة الأسعار لمنتج واجهة برمجة التطبيقات الجديد في نص الطلب. باستثناء مصفوفة 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

حذف منتج واجهة برمجة التطبيقات من حزمة منتجات واجهة برمجة التطبيقات

لحذف منتج واجهة برمجة تطبيقات من حزمة منتجات ضمن واجهة برمجة التطبيقات، يمكنك إرسال طلب حذف إلى organizations/{org_name}/monetization-packages/{package_id}/products/{product_id}, حيث يحدّد {org_name} اسم مؤسستك، {package_id} تحدّد اسم حزمة منتجات واجهة برمجة التطبيقات، ويحدّد {product_id} معرّف واجهة برمجة التطبيقات المنتج.

على سبيل المثال:

$ 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

عرض حِزم منتجات واجهة برمجة التطبيقات باستخدام واجهة برمجة التطبيقات

يمكنك استرداد حزمة منتج واجهة برمجة تطبيقات معيّنة أو جميع حِزم منتجات واجهة برمجة التطبيقات في مؤسسة. يمكنك أيضًا استرداد حِزم منتجات واجهة برمجة التطبيقات التي تتضمّن معاملات في نطاق زمني محدّد، أي حزم فقط المستخدمون الذين يستدعون التطبيقات التي تصل إلى واجهات برمجة التطبيقات في هذه الحزم ضمن بداية ونهاية محدّدة التاريخ.

عرض حزمة منتج واجهة برمجة تطبيقات معيّنة: لاسترداد حزمة منتج واجهة برمجة تطبيقات معيّنة، يمكنك إصدار طلب 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

عرض كل حِزم منتجات واجهة برمجة التطبيقات: لاسترداد كل حِزم منتجات واجهة برمجة التطبيقات في مؤسسة، يجب إصدار أمر 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

يمكنك تمرير مَعلمات طلب البحث التالية لفلترة النتائج:

يجب أن تبدو الاستجابة لعرض جميع حِزم منتجات واجهة برمجة التطبيقات في مؤسسة على النحو التالي (الجزء فقط من من الرد):

{
  "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
}

عرض حِزم منتجات واجهة برمجة التطبيقات التي تتضمّن معاملات: لاسترداد حِزم منتجات واجهة برمجة التطبيقات التي تتضمّن معاملات في نطاق زمني معين، يمكنك إصدار طلب GET إلى /organizations/{org_name}/packages-with-transactions عند إصدار الطلب تحتاج إلى تحديد تاريخ بدء وتاريخ انتهاء للنطاق الزمني كمعلمات طلب بحث. بالنسبة على سبيل المثال، يسترد الطلب التالي حِزم منتجات واجهة برمجة التطبيقات مع المعاملات خلال الشهر آب (أغسطس) 2013.

$ 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"
  },
     ...
  } ]
}

عرض حِزم منتجات واجهة برمجة التطبيقات التي يقبلها مطوّر برامج أو شركة باستخدام واجهة برمجة التطبيقات

عرض حِزم منتجات واجهة برمجة التطبيقات التي يقبلها مطوِّر معيّن أو شركة محدّدة عن طريق إصدار رمز GET إلى واجهات برمجة التطبيقات التالية، على التوالي:

• /organizations/{org_name}/developers/{developer_id}/monetization-packages، حيث {developer_id} هو رقم التعريف (عنوان البريد الإلكتروني) للمطوّر.
• /organizations/{org_name}/companies/{company_id}/monetization-packages، حيث {company_id} هو الرقم التعريفي للشركة.

عند إصدار الطلب، يمكنك اختياريًا تحديد مَعلمات طلب البحث التالية:

على سبيل المثال، يسترد الطلب التالي جميع حِزم منتجات واجهة برمجة التطبيقات المقبولة من قِبل مجموعة محدّدة المطور:

$ 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

حذف حزمة منتجات من واجهة برمجة التطبيقات باستخدام واجهة برمجة التطبيقات

لا يمكنك حذف حزمة منتجات من واجهة برمجة التطبيقات إلا إذا لم يتم تحديد أي خطط أسعار محدّدة لها.

لحذف حزمة منتجات من واجهة برمجة التطبيقات لم يتم تحديد أي خطط أسعار لها، يمكنك إرسال طلب "حذف" إلى organizations/{org_name}/monetization-packages/{package_id}، حيث يحدّد {org_name} اسم مؤسستك و{package_id} تحدد اسم حزمة منتجات واجهة برمجة التطبيقات.

على سبيل المثال:

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

خصائص إعداد حزمة المنتجات في واجهة برمجة التطبيقات

تظهر خيارات ضبط حزمة منتجات واجهة برمجة التطبيقات التالية لواجهة برمجة التطبيقات: