إدارة خطط الأسعار

أنت الآن بصدد الاطّلاع على مستندات Apigee Edge.
انتقِل إلى مستندات Apigee X. info

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

استكشاف صفحة "خطط الأسعار"

يمكنك الوصول إلى صفحة "خطط الأسعار" باتّباع الخطوات الموضّحة أدناه.

إنشاء خطة أسعار

لإنشاء خطة أسعار، اتّبِع الخطوات التالية:

1. الوصول إلى صفحة "خطط الأسعار"
2. انقر على +خطة أسعار.
3. اضبط الحقول التالية في اللوحة العلوية:
   

   الحقل	الوصف	تلقائي	مطلوب
   اسم خطة الأسعار	اسم خطة الأسعار. NOTE: يجب أن يكون الاسم فريدًا ضمن حزمة منتجات واجهة برمجة التطبيقات. لا يمكن أن يكون لخطتَين في حزمة المنتج نفسها الاسم نفسه.	لا ينطبق	نعم
   نوع خطة الأسعار	نوع خطة الأسعار اختَر قيمة من القائمة المنسدلة. للاطّلاع على قائمة بأنواع خطط الأسعار الصالحة، راجِع أنواع خطط الأسعار المتوافقة.	لا ينطبق	نعم
   حزمة المنتجات	حزمة منتجات واجهة برمجة التطبيقات اختَر قيمة من القائمة المنسدلة. لمزيد من المعلومات حول حِزم منتجات واجهة برمجة التطبيقات، يُرجى الاطّلاع على إدارة حِزم منتجات واجهة برمجة التطبيقات. إذا اخترت حزمة منتجات تحتوي على أكثر من منتج واحد من منتجات واجهة برمجة التطبيقات، عليك اختيار ما إذا كنت تريد ضبط خطط أسعار فردية لكل منتج من منتجات واجهة برمجة التطبيقات أو خطة أسعار عامة سيتم تطبيقها على جميع منتجات واجهة برمجة التطبيقات.	لا ينطبق	نعم
   الجمهور	الجمهور الذي يمكنه الوصول إلى خطة الأسعار اختَر إحدى القيم التالية من القائمة المنسدلة: الجميع: جميع المطوّرين المطوِّر: المطوِّر أو الشركة أدخِل اسم المطوّر أو الشركة. أثناء الكتابة، ستظهر قائمة بالمطوّرين أو الشركات التي تتضمّن السلسلة في قائمة منسدلة. انقر على اسم المطوّر أو الشركة من القائمة المنسدلة. فئة المطوِّر: فئة المطوِّر اختَر فئة المطوّر من القائمة المنسدلة. اضبط فئات المطوّرين حسب الحاجة، كما هو موضّح في إدارة فئات المطوّرين.	الجميع	لا
   تاريخ البدء	تاريخ بدء سريان خطة الأسعار أدخِل تاريخ البدء أو اختَر تاريخًا باستخدام التقويم.	اليوم	لا
   تاريخ الانتهاء	تاريخ انتهاء خطة الأسعار. لتحديد تاريخ انتهاء، فعِّل خيار تضمين تاريخ انتهاء وأدخِل تاريخ انتهاء أو اختَر تاريخًا باستخدام التقويم. ملاحظة: ستكون خطة الأسعار سارية حتى نهاية اليوم في التاريخ المحدّد. إذا أردت انتهاء صلاحية خطة أسعار في 1 كانون الأول (ديسمبر) 2018 مثلاً، عليك ضبط قيمة endDate على 2018-11-30. في هذه الحالة، ستنتهي صلاحية خطة الأسعار في نهاية يوم 30 تشرين الثاني (نوفمبر) 2018، وسيتم حظر جميع الطلبات في 1 كانون الأول (ديسمبر) 2018.	بلا	لا
   مرئية للبوابات	اضبط ما إذا كانت خطة الأسعار علنية أو خاصة. مقارنة خطط الأسعار العامة بخطط الأسعار الخاصة	الأجهزة المفعّلة	لا

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

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

6. اضبط تفاصيل خطة الأسعار استنادًا إلى نوع خطة الأسعار المحدّدة:
   
   • Freemium
   • بطاقة الأسعار
   • الحصة من الإيرادات
   • إشعار قابل للتعديل
7. انقر على أحد الخيارات التالية:
   

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

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

تعديل خطة أسعار

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

لتعديل خطة أسعار، اتّبِع الخطوات التالية:

1. الوصول إلى صفحة "خطط الأسعار"
2. انقر داخل صف خطة الأسعار التي تريد تعديلها.
   يتم عرض لوحة خطة الأسعار.
3. عدِّل حقول خطة الأسعار حسب الحاجة.
   NOTE: بعد نشر خطة أسعار، يمكنك تعديل تاريخ الانتهاء فقط إذا لم يتم ضبطه من قبل.
4. انقر على أحد الخيارَين التاليَين:

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

حذف خطة أسعار مسودّة

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

ملاحظة: لا يمكنك حذف خطة أسعار تم نشرها.

لحذف خطة أسعار مسودّة، اتّبِع الخطوات التالية:

1. الوصول إلى صفحة "خطط الأسعار"
2. ضَع مؤشر الماوس فوق خطة الأسعار التي تريد حذفها لعرض قائمة الإجراءات.
3. انقر على .
4. انقر على حذف لتأكيد الإجراء.

إدارة خطط الأسعار باستخدام واجهة برمجة التطبيقات

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

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

لإنشاء خطة أسعار، أرسِل طلب POST إلى /organizations/{org_name}/monetization-packages/{monetizationpackage_id}/rate-plans، حيث {monetizationpackage_id} هو معرّف حزمة منتجات واجهة برمجة التطبيقات التي تريد إنشاء خطة أسعار لها (يتم عرض المعرّف في الردّ عند إنشاء حزمة منتجات واجهة برمجة التطبيقات).

عند إنشاء خطة أسعار، يجب تحديد ما يلي في نص الطلب:

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

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

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

توضّح الأقسام التالية كيفية إنشاء خطط أسعار:

• إنشاء خطة أسعار عادية باستخدام واجهة برمجة التطبيقات
• إنشاء خطة أسعار خاصة بالمطوّرين أو الشركات باستخدام واجهة برمجة التطبيقات
• إنشاء خطة أسعار خاصة بفئة المطوّرين باستخدام واجهة برمجة التطبيقات
• إنشاء خطة أسعار خاصة بمنتج واجهة برمجة التطبيقات باستخدام واجهة برمجة التطبيقات
• ضبط خطة الأسعار على "عامة" أو "خاصة" باستخدام واجهة برمجة التطبيقات

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

لإنشاء خطة أسعار عادية، اضبط السمة type على STANDARD، كما هو موضّح في المثال التالي.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Simple rate plan",
     "currency": {
      "id" : "usd"
     },
     "description": "Simple rate plan",
     "displayName" : "Simple rate plan",
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },
     "published": true,
     "isPrivate" : false,
     "ratePlanDetails": [
     {
      …
     }
     ],
     "startDate": "2013-09-15",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location_package/rate-plans" \
-u email:password

إنشاء خطة أسعار للمطوّرين أو الشركات باستخدام واجهة برمجة التطبيقات

لتطبيق خطة الأسعار على مطوّر أو شركة معيّنة، اضبط قيمة type على Developer. عليك أيضًا تحديد المطوّر أو الشركة في الطلب، مع تحديد رقم التعريف والاسم القانوني واسم المطوّر أو الشركة.

على سبيل المثال، ينشئ المقتطف التالي خطة أسعار للمطوّر Dev Five:

...
     "type": "DEVELOPER",
       "developer" : {
        "id" : "0mkKu1PALUGfjUph",
        "legalName" : "DEV FIVE",
        "name" : "Dev Five"
      }
...

إنشاء خطة أسعار لفئة المطوّرين باستخدام واجهة برمجة التطبيقات

لتطبيق خطة الأسعار على فئة مطوّرين، اضبط قيمة type على Developer_Category. عليك أيضًا تحديد فئة المطوّر في الطلب. على سبيل المثال:

...
     "type": "DEVELOPER_CATEGORY",
       "developerCategory" : {
        "id" : "5e172299-8232-45f9-ac46-40076139f373",
        "name" : "Silver",
        "description" : "Silver category"
      }
...

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

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

على سبيل المثال، ينشئ ما يلي خطة مشاركة أرباح تتضمّن منتجَين من منتجات واجهة برمجة التطبيقات:

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Multi-product rate plan",
     "currency": {
      "id" : "usd"
     },
     "description": "Multi-product rate plan",
     "displayName" : "Multi-product rate plan",
     "monetizationPackage": {
      "id": "mypackage",
      ...
     },
     "organization": {
      "id": "{org_name}",
      ...
     },
     "published": true,
     "isPrivate" : false,
     "ratePlanDetails": [
     {
        "ratePlanRates":[{
            "revshare":0,
            "startUnit":0,
            "type":"REVSHARE",
            "endUnit":null
        }],
       "revenueType":"NET",
       "type":"REVSHARE"
       "currency":{...},
       "product":{"id":"product1","displayName":"Product1"},
       "customPaymentTerm":false
     },
     {
        "ratePlanRates":[{
            "revshare":10,
            "startUnit":0,
            "type":"REVSHARE",
            "endUnit":null
        }],
       "revenueType":"NET",
       "type":"REVSHARE"
       "currency":{...},
       "product":{"id":"product2","displayName":"Product2"},
       "customPaymentTerm":false
     }
     ],
     "startDate": "2019-09-15",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/my-package/rate-plans" \
-u email:password

لإضافة منتج API إلى حزمة منتجات API في my-package، عليك إضافة تفاصيل خطة الأسعار لمنتج API في نص الطلب، كما هو موضّح في إضافة منتج API إلى حزمة منتجات API باستخدام خطط أسعار خاصة بمنتج API.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
    "ratePlan": [
    {
        "id": "my-package_multi-product-rate-plan",
        "ratePlanDetails": [
        {
            "ratePlanRates":[{
                "revshare":20,
                "startUnit":0,
                "type":"REVSHARE",
                "endUnit":null
             }],
             "revenueType":"NET",
             "type":"REVSHARE"
             "currency":{...},
             "customPaymentTerm":false
         }]
    }]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/my-package/products/product3" \
-u email:password

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

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

على سبيل المثال، ينشئ ما يلي خطة أسعار خاصة:

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Simple rate plan",
     "currency": {
      "id" : "usd"
     },
     "description": "Simple rate plan",
     "displayName" : "Simple rate plan",
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },
     "published": true,
     "isPrivate" : true,
     "ratePlanDetails": [
     {
      …
     }
     ],
     "startDate": "2013-09-15",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location_package/rate-plans" \
-u email:password

نشر خطة أسعار باستخدام واجهة برمجة التطبيقات

لنشر خطة أسعار، اضبط قيمة السمة published على "صحيح" عند إنشاء خطة الأسعار. سيتمكّن المطوّرون من الاطّلاع على خطة الأسعار بدءًا من التاريخ المحدّد في السمة startDate الخاصة بالخطة.

على سبيل المثال، ينشئ ما يلي خطة بطاقة أسعار وينشرها (يتم عرض جزء فقط من الطلب):

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Flat rate card plan",
     "developer":null,
     "developerCategory":null,
     "advance": "false",
     …
     "published": "true",
     "ratePlanDetails": [
     …
      ],
     …
     "type": "RATECARD"
     }],
     …
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

حفظ مسودة خطة أسعار باستخدام واجهة برمجة التطبيقات

لحفظ خطة أسعار بدون نشرها، اضبط قيمة السمة published على false عند إنشاء خطة الأسعار.

على سبيل المثال، ينشئ ما يلي خطة بطاقة أسعار ويحفظها كمسودة (يتم عرض جزء فقط من الطلب):

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Flat rate card plan",
     "developer":null,
     "developerCategory":null,
     "advance": "false",
     …
     "published": "false",
     "ratePlanDetails": [
     …
      ],
     …
     "type": "RATECARD"
     }],
     …
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

تعديل مسودة خطة أسعار باستخدام واجهة برمجة التطبيقات

لتعديل مسودة خطة أسعار، أرسِل طلب PUT إلى /organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_Id}، حيث {package_id} هو معرّف حزمة واجهة برمجة التطبيقات، و{plan_Id} هو معرّف خطة الأسعار. عند إجراء التعديل، عليك تحديد الإعدادات المعدَّلة ومعرّف خطة الأسعار في نص الطلب. في حال تعديل سعر خطة الأسعار، عليك أيضًا تحديد معرّف سعر خطة الأسعار. على سبيل المثال، يعدّل الطلب التالي سعر خطة الأسعار في خطة أسعار معرّفها location_flat_rate_card_plan (تم تمييز التعديل):

$ curl -H "Content-Type: application/json" -X PUT -d \
 '{
      "id" : "location_flat_rate_card_plan",
      "name": "Flat rate card plan",
      "advance": "false",
      "currency": {
       "id" : "usd"
      },
      "description": "Flat rate card plan",
      "displayName" : "Flat rate card plan",
      "frequencyDuration": "30",
      "frequencyDurationType": "DAY",
      "earlyTerminationFee": "10",
      "monetizationPackage": {
       "id": "location"
      },
      "organization": {
       "id": "{org_name}"
      },
      "paymentDueDays": "30",
      "prorate": "false",
      "published": "false",
      "ratePlanDetails": [
      {
       "currency": {
        "id" : "usd"
       },
       "paymentDueDays": "30",
       "meteringType": "UNIT",
       "organization": {
        "id": "{org_name}"
       },
       "ratePlanRates": [
        {
         "id" : "26b69b0b-9863-48c9-ba73-74a5b918fcec",
         "type": "RATECARD",
         "rate": "0.15",
         "startUnit": "0"
        }
       ],
      "ratingParameter": "VOLUME",
      "type": "RATECARD"
      }],
      "recurringStartUnit": 1,
      "recurringType": "CALENDAR",
      "recurringFee": "10",
      "setUpFee": "10",
      "startDate": "2013-09-15 00:00:00",
      "type": "STANDARD"
 }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans/location_flat_rate_card_plan" \
-u email:password

تتضمّن الاستجابة السعر المعدَّل لخطة الأسعار (يتم عرض جزء فقط من الاستجابة):

…
"ratePlanRates" : [ {
  "id" : "26b69b0b-9863-48c9-ba73-74a5b918fcec",
  "rate" : 0.15,
  "startUnit" : 0,
  "type" : "RATECARD"
} ],
…

عرض خطط الأسعار باستخدام واجهة برمجة التطبيقات

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

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

عرض جميع خطط الأسعار الخاصة بمؤسسة باستخدام واجهة برمجة التطبيقات

للاطّلاع على جميع خطط الأسعار الخاصة بمؤسسة، أرسِل طلب استرداد بيانات باستخدام GET إلى /mint/organizations/{org_name}/rate-plans، حيث {org_name} هو اسم مؤسستك.

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

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

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/rate-plans" \
  -u email:password

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

لعرض جميع خطط الأسعار لحزمة واجهة برمجة تطبيقات، أرسِل طلب استرداد بيانات باستخدام GET إلى /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans، حيث {package_id} هو معرّف حزمة واجهة برمجة التطبيقات (يتم عرض معرّف الحزمة عند إنشاء حزمة تحقيق الربح).

بشكلٍ تلقائي، لا يتم عرض سوى خطط الأسعار النشطة والعامة والعادية في النتائج. يجب تضمين ما يلي:

• بالنسبة إلى خطط الأسعار المسودّة أو المنتهية الصلاحية، اضبط معلَمة طلب البحث current على false (على سبيل المثال، ?current=false).
• خطط الأسعار الخاصة، اضبط مَعلمة طلب البحث showPrivate على true (مثلاً، ?showPrivate=true).
• جميع خطط الأسعار العادية، اضبط مَعلمة طلب البحث standard على true (على سبيل المثال، ?standard=true).

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

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/communications/rate-plans" \
  -u email:password

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

لعرض خطة أسعار لحزمة واجهة برمجة تطبيقات، أرسِل طلب استرداد بيانات باستخدام GET إلى /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_id}، حيث {package_id} هو معرّف حزمة واجهة برمجة التطبيقات، و{plan_id} هو معرّف خطة الأسعار (يتم عرض معرّف الحزمة عند إنشاء حزمة تحقيق الربح، ويتم عرض معرّف خطة الأسعار عند إنشاء خطة الأسعار).

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

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/communications/rate-plans/communications_standard_fixed_plan" \
  -u email:password

في ما يلي مثال على الردّ:

{
   "advance" : true,
   "contractDuration" : 1,
   "contractDurationType" : "YEAR",
   "currency" : {
     "id" : "usd",
     ...
     "organization" : {
       ...
     },
     ...
   },
   "description" : "Standard Fixed Plan",
   "displayName" : "Standard Fixed Plan",
   "earlyTerminationFee" : 0.0000,
   "frequencyDuration" : 1,
   "frequencyDurationType" : "MONTH",
   "id" : "communications_standard_fixed_plan",
   "isPrivate" : false,
   "monetizationPackage" : {
     "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"
   },
   "name" : "Standard Fixed Plan",
   "organization" : {
     ...
   },
   "paymentDueDays" : "30",
   "prorate" : true,
   "published" : true,
   "ratePlanDetails" : [ {
     "aggregateFreemiumCounters" : true,
     "aggregateStandardCounters" : true,
     "currency" : {
       "id" : "usd",
       "name" : "USD",
       "organization" : {
        ...
       },
       "status" : "ACTIVE",
       "virtualCurrency" : false
     },
     "id" : "cb92f7f3-7331-446f-ad63-3e176ad06a86",
     "meteringType" : "UNIT",
     "organization" : {
      ...
     },
     "paymentDueDays" : "30",
     "ratePlanRates" : [ {
       "id" : "07eefdfb-4db5-47f6-b182-5d606c6051c2",
       "rate" : 0.0500,
       "startUnit" : 0,
       "type" : "RATECARD"
     } ],
     "ratingParameter" : "VOLUME",
     "type" : "RATECARD"
   } ],
   "recurringFee" : 200.0000,
   "recurringStartUnit" : 1,
   "recurringType" : "CALENDAR",
   "setUpFee" : 100.0000,
   "startDate" : "2013-01-11 22:00:00",
   "type" : "STANDARD"
 }

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

لعرض جميع خطط الأسعار النشطة لأحد المطوّرين، أرسِل طلب GET إلى /mint/organizations/{org_name}/developers/{developer_id}/developer-rateplans، حيث {developer_id} هو عنوان البريد الإلكتروني للمطوّر.

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

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

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans" \
  -u email:password

في ما يلي مثال على الردّ:

{
  "ratePlan" : [ {
    "advance" : true,
    "contractDuration" : 1,
    "contractDurationType" : "MONTH",
    "currency" : {
      "description" : "United States Dollar",
      "displayName" : "United States Dollar",
      "id" : "usd",
      "name" : "USD",
      "organization" : {
        ...
      },
      "status" : "ACTIVE",
      "virtualCurrency" : false
    },
    "description" : "Fee Only RatePlan",
    "displayName" : "Fee Only RatePlan",
    "earlyTerminationFee" : 10.0000,
    "freemiumDuration" : 0,
    "freemiumDurationType" : "MONTH",
    "freemiumUnit" : 0,
    "frequencyDuration" : 1,
    "frequencyDurationType" : "WEEK",
    "id" : "messaging_package_fee_only_rateplan",
    "isPrivate" : false,
    "monetizationPackage" : {
      "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"
    },
    "name" : "Fee Only RatePlan",
    "organization" : {
     ...
    },
    "paymentDueDays" : "30",
    "prorate" : false,
    "published" : true,
    "ratePlanDetails" : [ ],
    "recurringFee" : 10.0000,
    "recurringStartUnit" : 1,
    "recurringType" : "CALENDAR",
    "setUpFee" : 20.0000,
    "startDate" : "2013-02-20 00:00:00",
    "type" : "STANDARD"
  } ],
  "totalRecords" : 1
}

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

لعرض خطة أسعار نشطة لأحد المطوّرين، أرسِل طلب GET إلى /mint/organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id}، حيث {developer_id} هو عنوان البريد الإلكتروني للمطوّر، و{developer_rateplan_id} هو معرّف خطة الأسعار المقبولة التي يتم عرضها في الردّ عند قبول خطة الأسعار المنشورة.

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

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans/messaging_package_fee_only_rateplan" \
  -u email:password

في ما يلي مثال على الردّ:

{
    "created" : "2018-01-25 20:01:54",
    "developer" : {
    },
    "id" : "a73s104-276f-45b3-8075-83d1046ea550",
    "nextCycleStartDate" : "2018-02-19 00:00:00",
    "nextRecurringFeeDate" : "2018-02-19 00:00:00",
    "prevRecurringFeeDate" : "2018-01-25 00:00:00",
    "ratePlan" : {
      "frequencyDuration" : 1,
      "frequencyDurationType" : "MONTH",
      "recurringFee" : 0.0000,
      "recurringStartUnit" : 19,
      "recurringType" : "CALENDAR",
      "setUpFee" : 0.0000,
      "type" : "STANDARD"
    },
    "startDate" : "2018-01-25 20:01:54",
    "updated" : "2018-01-25 20:01:54"
  }

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

لعرض خطة أسعار مقبولة لأحد المطوّرين تتضمّن منتجًا من منتجات واجهة برمجة التطبيقات، أرسِل طلب استرداد بيانات باستخدام GET إلى /mint/organizations/{org_id}/developers/{developer_id}/products/{product_id}/rate-plan-by-developer-product، حيث {developer_id} هو رقم تعريف المطوّر و/{product_id} هو رقم تعريف المنتج.

بشكلٍ تلقائي، يتم عرض خطة أسعار متاحة للجميع فقط في النتائج. لعرض خطة أسعار خاصة، اضبط مَعلمة طلب البحث showPrivate على true (على سبيل المثال، ?showPrivate=true).

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

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/products/location/rate-plan-by-developer-product" \
  -u email:password

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

للاطّلاع على خطط الأسعار التي قبلها أحد المطوّرين، أرسِل طلب استرداد بيانات باستخدام GET إلى /mint/organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans، حيث {developer_id} هو رقم تعريف المطوّر.

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

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

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-accepted-rateplans" \
  -u email:password

في ما يلي مثال على الردّ:

{
  "developerRatePlan" : [ {
     "created" : "2018-01-25 20:01:54",
     "developer" : { ...
     },
     "id" : "a73s104-276f-45b3-8075-83d1046ea550",
     "nextCycleStartDate" : "2018-02-19 00:00:00",
     "nextRecurringFeeDate" : "2018-02-19 00:00:00",
     "prevRecurringFeeDate" : "2018-01-25 00:00:00",
     "ratePlan" : {
       "frequencyDuration" : 1,
       "frequencyDurationType" : "MONTH",
       "recurringFee" : 0.0000,
       "recurringStartUnit" : 19,
       "recurringType" : "CALENDAR",
       "setUpFee" : 0.0000,
       "type" : "STANDARD"
     },
     "startDate" : "2018-01-25 20:01:54",
     "updated" : "2018-01-25 20:01:54"
   }],
   "totalRecords" : 1
}

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

لحذف مسودة خطة أسعار، أرسِل طلب DELETE إلى /organizations/{org_name}/monetization-packages/package_id}/rate-plans/{plan_Id}، حيث {plan_Id} هو معرّف خطة الأسعار المطلوب حذفها، و{package_id} هو معرّف حزمة واجهة برمجة التطبيقات لخطة الأسعار. على سبيل المثال:

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

خصائص الإعداد لخطط الأسعار

عند إنشاء خطة أسعار باستخدام واجهة برمجة التطبيقات، يمكنك تحديد إعدادات الضبط التالية.

سمات الإعدادات لتفاصيل خطة الأسعار

يمكنك تحديد أيّ من خصائص الإعداد التالية كجزء من مصفوفة ratePlanDetails عند إنشاء خطة الأسعار.