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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

لحذف منتج واجهة برمجة التطبيقات من حزمة منتجات واجهة برمجة التطبيقات، أرسِل طلب 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

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

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

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

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

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

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

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

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