تمت ترجمة هذه الصفحة بواسطة Cloud Translation API‏.

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

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

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

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

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

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

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

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

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

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

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

انتقِل إلى صفحة "حِزم المنتجات" على النحو الموضَّح أدناه.

Edge

للوصول إلى صفحة حِزم المنتجات في واجهة برمجة التطبيقات باستخدام واجهة مستخدم Edge، اختَر نشر > تحقيق الربح > حِزم المنتجات في شريط التنقّل الأيمن.

كما هو موضّح في الشكل السابق، تتيح لك صفحة حِزم المنتجات ما يلي:

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

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

كلاسيكي Edge (السحابة الإلكترونية الخاصة)

للوصول إلى صفحة حزم واجهة برمجة التطبيقات باستخدام واجهة مستخدم Edge Edge، حدد نشر > الحزم في شريط التنقل العلوي.

تتيح لك صفحة حزم واجهة برمجة التطبيقات إجراء ما يلي:

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

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

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

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

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

أثناء كتابة اسم منتج واجهة برمجة التطبيقات، يتم عرض قائمة من منتجات واجهة برمجة التطبيقات التي تحتوي على السلسلة في قائمة منسدلة. انقر على اسم منتج واجهة برمجة التطبيقات لإضافته إلى الحزمة. كرِّر هذه الخطوة لإضافة منتجات أخرى من واجهة برمجة التطبيقات.
كرِّر الخطوة 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

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

لحذف منتج واجهة برمجة التطبيقات من حزمة منتجات واجهة برمجة التطبيقات، يمكنك إصدار طلب DELETE (حذف) إلى 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

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

تفاصيل دخول طلب البحث	الوصف
`all`	علامة تحدّد ما إذا كان يجب عرض جميع حِزم المنتجات في واجهة برمجة التطبيقات في حال ضبط هذه السياسة على false، يتمّ تحديد عدد حِزم منتجات واجهة برمجة التطبيقات التي يتم عرضها لكل صفحة من خلال مَعلمة طلب البحث `size`. تكون القيمة التلقائية false.
`size`	عدد حِزم منتجات واجهة برمجة التطبيقات التي يتم عرضها لكل صفحة. يكون الإعداد التلقائي بالقيمة 20. في حال ضبط معلَمة طلب البحث `all` على `true`، سيتم تجاهل هذه المعلَمة.
`page`	رقم الصفحة التي تريد عرضها (إذا كان المحتوى مقسّمًا على صفحات). في حال ضبط معلَمة طلب البحث `all` على `true`، يتم تجاهل هذه المعلَمة.

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

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

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

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

تفاصيل دخول طلب البحث	الوصف	تلقائي
`current`	علامة تحدد ما إذا كان سيتم استرداد حِزم منتجات واجهة برمجة التطبيقات النشطة فقط (`current=true`) أو جميع الحِزم (`current=false`). تُعتبر جميع خطط الأسعار في الحزمة النشطة متاحة.	`current=false`
`allAvailable`	علامة تحدد ما إذا كان سيتم استرداد جميع حِزم منتجات واجهة برمجة التطبيقات المتاحة (`allAvailable=true`) أو حِزم منتجات واجهة برمجة التطبيقات المتاحة فقط للمطوّر أو الشركة (`allAvailable=false`). تشير كل البيانات المتاحة إلى حِزم منتجات واجهة برمجة التطبيقات المتوفّرة للمطوّر أو الشركة المحدّدَين، بالإضافة إلى مطوّري برامج آخرين أو شركات أخرى. لا تحتوي حِزم منتجات واجهة برمجة التطبيقات المتاحة تحديدًا لشركة أو مطوّر برامج إلا على خطط الأسعار المتاحة حصريًا لتلك الشركة أو المطوّر.	`allAvailable=true`

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

$ 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

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

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

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

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

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

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

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

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

الاسم	الوصف	تلقائي	مطلوب؟
`description`	وصف لحزمة منتجات واجهة برمجة التطبيقات.	لا ينطبق	نعم
`displayName`	الاسم المطلوب عرضه لحزمة منتجات واجهة برمجة التطبيقات (على سبيل المثال، في كتالوج حِزم واجهة برمجة التطبيقات).	لا ينطبق	نعم
`name`	اسم حزمة المنتجات في واجهة برمجة التطبيقات	لا ينطبق	نعم
`organization`	المؤسسة التي تحتوي على حزمة منتجات واجهة برمجة التطبيقات.	لا ينطبق	لا
`product`	مصفوفة من منتج واحد أو أكثر في حزمة منتجات واجهة برمجة التطبيقات.	لا ينطبق	لا
`status`	مؤشر حالة لحزمة منتجات واجهة برمجة التطبيقات يمكن أن يحتوي مؤشر الحالة على إحدى القيم التالية: CREATED, ACTIVE, INACTIVE. ملاحظة: يتم حاليًا الاحتفاظ بقيمة مؤشر الحالة ضمن حزمة منتجات واجهة برمجة التطبيقات، ولكن لا يتم استخدامها.	لا ينطبق	نعم