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

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

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

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

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

Edge

لعرض خطط الأسعار في واجهة مستخدم Edge، انتقِل إلى صفحة "خطط الأسعار":

  1. سجِّل الدخول إلى apigee.com/edge.
  2. اختيار نشر > تحقيق الربح > خطط الأسعار في شريط التنقّل الأيمن

ستظهر لك صفحة "خطط الأسعار".

كما هو موضّح في الشكل، تتيح لك صفحة "خطط الأسعار" تنفيذ ما يلي:

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

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

  1. سجِّل الدخول إلى http://ms-ip:9000، حيث يشير ms-ip إلى عنوان IP أو اسم نظام أسماء النطاقات لعقدة خادم الإدارة.
  2. اختَر نشر > الحِزم في شريط التنقّل العلوي.

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

تتيح لك صفحة "خطط الأسعار" تنفيذ ما يلي:

وضع خطة أسعار

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

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

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

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

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

    		لا ينطبق نعم
    الجمهور شريحة الجمهور التي يمكنها الوصول إلى خطة الأسعار حدد إحدى القيم التالية من القائمة المنسدلة:
    • الجميع - جميع المطوّرين.
    • مطوّر البرامج - مطوّر البرامج أو الشركة أدخِل اسم المطوّر أو الشركة. أثناء الكتابة، يتم عرض قائمة بالمطوّرين/الشركات التي تحتوي على السلسلة في قائمة منسدلة. انقر على اسم المطوّر أو الشركة من القائمة المنسدلة.
    • فئة المطوّرين: فئة مطوّر البرامج اختَر فئة المطوّر من القائمة المنسدلة.

      اضبط فئات المطوِّرين على النحو المطلوب، كما هو موضَّح في إدارة فئات المطوِّرين.

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

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

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

    ملاحظة: تأكَّد من ضبط جميع المنتجات في حزمة المنتجات.

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

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

    نشر خطة جديدة انشر الخطة.

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

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

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

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

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

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

    لن تظهر خطة الأسعار لمطوّري التطبيقات إلى أن تنشرها. يمكنك تعديل أي حقل في مسودة خطة السعر.
    نشر المسودة (خطط أسعار المسودة) انشر خطة الأسعار.

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

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

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

احذف مسودة خطة أسعار إذا لم تعد ضرورية.

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

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

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

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

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

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

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

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

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

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

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

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

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

لإنشاء خطة سعر عادية، اضبط السمة 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

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

$ 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 على "خطأ" عند إنشاء خطة الأسعار.

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

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

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

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

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

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

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

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

مثلاً:

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

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

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

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

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

مثلاً:

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

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

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

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

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

مثلاً:

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
}

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

لحذف مسودة خطة أسعار، يجب إرسال طلب "حذف" إلى /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

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

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

الاسم الوصف تلقائي مطلوب؟
advance

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

  • true - يتم تحصيل رسوم متكررة مسبقًا. على سبيل المثال، إذا كانت المدة شهرًا واحدًا، يتم تحصيل الرسوم المتكرّرة من الفاتورة التي تم إنشاؤها عند انتهاء شهر الفوترة السابق.
  • false - يتم تحصيل رسوم متكرّرة في نهاية الفترة. على سبيل المثال، إذا كانت المدة شهرًا واحدًا، يتم تحصيل الرسوم المتكرّرة في الفاتورة عند انتهاء شهر الفوترة الحالي. وهذا هو الخيار التلقائي.
 false لا
contractDuration

مدة عقد الخطة مع contractDurationType. على سبيل المثال، لتحديد مدة العقد 6 أشهر، اضبط contractDuration على 6 وcontractDurationType على MONTH.

 لا ينطبق لا
contractDurationType

مدة عقد الخطة مع contractDuration. وتشمل القيم الصالحة ما يلي:

  • DAY
  • WEEK
  • MONTH
  • QUARTER
  • YEAR
 لا ينطبق لا
currency

العملة المستخدمة لخطة الأسعار. حدِّد رمز ISO 4217 للعملة، مثل usd للدولار الأمريكي أو chf للفرنك السويسري.

 لا ينطبق نعم
description

وصف خطة الأسعار

 لا ينطبق نعم
developer

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

 لا ينطبق لا
developerCategory

رقم تعريف فئة المطوِّرين. يتوفّر هذا الخيار لخطط أسعار فئات المطوِّرين فقط.

 لا ينطبق لا
displayName

اسم معروض سهل الاستخدام لخطة الأسعار

 لا ينطبق نعم
earlyTerminationFee

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

 لا ينطبق لا
endDate

تاريخ انتهاء الخطة. لا يمكن للمطوّرين الاطّلاع على خطة الأسعار بعد هذا التاريخ. إذا كنت لا تريد أن تنتهي خطة الأسعار في تاريخ محدّد، حدِّد قيمة فارغة للسمة endDate.

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

ملاحظة: عند الاطّلاع على خطة الأسعار باستخدام واجهة برمجة التطبيقات، يتم تحديد الطابع الزمني للسمة endDate على أنّه YYYY-MM-DD 00:00:00، ما قد يكون مضللاً.

 لا ينطبق لا
freemiumDuration

فترة زمنية لفترة التطبيقات المجانية المحدودة مع freemiumDurationType. على سبيل المثال، لتحديد أنّ الفترة المجانية المحدودة هي 30 يومًا، اضبط السمة freemiumDuration على 30 والقيمة freemiumDurationType على DAY.

 لا ينطبق لا
freemiumDurationType

فترة زمنية لفترة التطبيقات المجانية المحدودة مع freemiumDuration. وتشمل القيم الصالحة ما يلي:

  • DAY
  • WEEK
  • MONTH
  • QUARTER
  • YEAR
 لا ينطبق لا
freemiumUnit

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

 لا ينطبق لا
frequencyDuration

هذا العرض صالح مقابل الرسوم المتكرّرة فقط. الفترة الزمنية بين تحصيل الرسوم المتكرّرة مع frequencyDurationType. على سبيل المثال، لتحديد أنّ الفترة الزمنية بين تحصيل الرسوم هي 30 يومًا، اضبط السمة frequencyDuration على 30 والقيمة frequencyDurationType على DAY.

 لا ينطبق لا
frequencyDurationType هذا العرض صالح مقابل الرسوم المتكرّرة فقط. الفترة الزمنية بين تحصيل الرسوم المتكرّرة مع frequencyDuration. وتشمل القيم الصالحة ما يلي:
  • DAY
  • WEEK
  • MONTH
  • QUARTER
  • YEAR
 لا ينطبق لا
isPrivate علامة تحدّد ما إذا كانت خطة الأسعار علنية أو خاصة وتكون الإعدادات التلقائية على false (علنية). لمزيد من المعلومات، اطّلِع على خطط الأسعار العلنية في مقابل الخاصة. لا ينطبق لا
monetizationPackage

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

 لا ينطبق لا
name

اسم خطة الأسعار

 لا ينطبق نعم
organization

رقم تعريف المؤسسة لخطة الأسعار.

 لا ينطبق نعم
paymentDueDays

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

 لا ينطبق لا
proRate

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

  • true - يتم تقسيم الرسوم الأولية حسب عدد الأيام حتى نهاية الفترة (أو عدد الأيام المستخدَمة فيها).
  • false - يتم تحصيل الرسوم المبدئية الكاملة من المطوّر بغض النظر عن وقت بدء (أو إنهاء) الخطة من خلال المطوِّر. وهذا هو الخيار التلقائي.
 false لا
published

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

  • true - نشر خطة الأسعار
  • false - لا تنشر خطة الأسعار.
 لا ينطبق نعم
ratePlanDetails

تفاصيل خطة الأسعار (راجِع خصائص الإعدادات للحصول على تفاصيل خطة الأسعار).

 لا ينطبق نعم
recurringFee

الرسوم التي يتمّ تحصيلها من المطوّر بشكل مستمر إلى أن ينهي المطوّر الخطة

 لا ينطبق لا
recurringStartUnit

يسري هذا العرض فقط في حال ضبط السمة recurringType على CALENDAR. هو يوم من الشهر لتحصيل الرسوم المتكررة. على سبيل المثال، إذا كان يتم تحصيل الرسوم المتكرّرة شهريًا وتم ضبط recurringStartUnit على 1، يتم تحصيل الرسوم المتكرّرة في اليوم الأول من كل شهر.

 لا ينطبق لا
recurringType

جدولة الرسوم المتكررة. وتشمل القيم الصالحة ما يلي:

  • CALENDAR، مجدولة استنادًا إلى تقويم
  • CUSTOM، تمت الجدولة استنادًا إلى إعداد تاريخ مخصّص.
 لا ينطبق لا
setUpFee

رسوم تُدفع لمرة واحدة يتم تحصيلها من كل مطوّر برامج في تاريخ بدء الخطة (أي تاريخ شراء المطوِّر للخطة).

 لا ينطبق لا
startDate

تاريخ بدء الخطة. يمكن للمطوّرين الاطّلاع على خطة الأسعار اعتبارًا من هذا التاريخ.

 لا ينطبق نعم
type

نوع خطة الأسعار عليك تحديد أحد الخيارات التالية:

  • STANDARD. يسري هذا الإعداد على جميع المطوّرين.
  • DEVELOPER_CATEGORY. ينطبق ذلك على جميع المطوّرين في فئة محدّدة.
  • DEVELOPER. يسري هذا الخيار على مطوّر معيّن أو شركة معيّنة.
 لا ينطبق نعم

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

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

الاسم الوصف تلقائي مطلوب؟
aggregateFreemiumCounters

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

  • true - تفعيل العدّادات المجمّعة
  • false - عدم تفعيل العدّادات المجمّعة.
 لا ينطبق لا
aggregateStandardCounters

علامة تحدّد ما إذا كان يتم استخدام عدّادات مجمّعة لتحديد نطاق الاستخدام (مثل نطاق الحجم لخطة بطاقة السعر) يمكن أن تكون القيمة واحدة مما يلي:

  • true - استخدام العدّادات المجمّعة
  • false - لا تستخدم العدّادات المجمّعة.
 لا ينطبق لا
aggregateTransactions

ملاحظة: لا تُستخدَم هذه السمة حاليًا لتحقيق الربح، ويمكن تجاهلها.

 صحيح لا
currency

Currency (العملة)

 لا ينطبق لا
duration

الفترة الزمنية لتكرار العملية الحسابية، بالإضافة إلى durationType، حيث تتراوح قيم duration المسموح بها من 1 إلى 24.

على سبيل المثال، اضبط duration على 2 وdurationType على MONTH لتحديد معدل تكرار عملية حسابية لمدة شهرَين.

 لا ينطبق لا
durationType

الفترة الزمنية لتكرار العملية الحسابية، بالإضافة إلى duration. القيمة الوحيدة الصالحة هي MONTH.

يمكن مراجعة duration للاطّلاع على مثال على الاستخدام.

 لا ينطبق لا
freemiumDuration

تمثّل هذه السمة فترة زمنية للفترة المجانية المحدودة لمنتج فردي من واجهة برمجة التطبيقات مع freemiumDurationType. على سبيل المثال، لتحديد أنّ الفترة المجانية المحدودة لمنتج واجهة برمجة التطبيقات هي 30 يومًا، اضبط السمة freemiumDuration على 30 والقيمة freemiumDurationType على DAY.

 لا ينطبق لا
freemiumDurationType

تمثّل هذه السمة فترة زمنية للفترة المجانية المحدودة لمنتج فردي من واجهة برمجة التطبيقات مع freemiumDuration. وتشمل القيم الصالحة ما يلي:

  • DAY
  • WEEK
  • MONTH
  • QUARTER
  • YEAR

على سبيل المثال، لتحديد أنّ الفترة المجانية لمنتج واجهة برمجة التطبيقات هي 30 يومًا، اضبط freemiumDuration على 30 وfreemiumDurationType على DAY.

 لا ينطبق لا
freemiumUnit

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

 لا ينطبق لا
meteringType

نموذج تحصيل الرسوم مقابل خطة بطاقة أسعار وتشمل القيم الصالحة ما يلي:

  • UNIT - نموذج الشحن بتعرفة ثابتة
  • VOLUME - نموذج الشحن بنطاق الصوت
  • STAIR_STEP - نموذج الشحن المجمّع
  • DEV_SPECIFIC - نموذج لشحن الإشعارات قابل للتعديل وغير صالح لأي نموذج أرباح آخر.
 لا ينطبق نعم
organization

رقم تعريف المؤسسة.

 لا ينطبق لا
paymentDueDays

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

 لا ينطبق لا
product

معلومات منتج واجهة برمجة التطبيقات، مثل المعرّف.

 لا ينطبق لا
ratePlanRates

تفاصيل الأسعار في خطة الأسعار، مثل نوع خطة الأسعار (REVSHARE أو RATECARD)، وسعر خطة بطاقة الأسعار، وحصة الأرباح لخطة حصة الأرباح، والنطاق (الوحدة الأولى والوحدة النهائية التي ينطبق عليها معدّل خطة الأسعار).

 لا ينطبق نعم
ratingParameter

الأساس الذي تستند إليه خطة الأسعار. تستند خطة الأسعار إلى المعاملات أو إلى سمة مخصّصة. وتشمل القيم الصالحة ما يلي:

  • VOLUME - تعتمد خطة الأسعار على حجم المعاملات.
  • custom_attribute - اسم السمة المخصّصة التي تم تحديدها في سياسة تسجيل المعاملات لمنتج واجهة برمجة التطبيقات، وهي صالحة لخطط بطاقة الأسعار فقط. لا يمكن تحديد اسم السمة المخصّصة على أنه VOLUME.
 VOLUME نعم
ratingParameterUnit

تم ضبط الوحدة التي تنطبق على ratingParameter. Only required if ratingParameter على سمة مخصّصة (أي، لم يتم ضبطها على VOLUME).

 لا ينطبق نعم
revenueType

أساس حصة الأرباح في خطة مشاركة الأرباح. وتشمل القيم الصالحة ما يلي:

  • GROSS - تستند حصة الأرباح إلى نسبة مئوية من السعر الإجمالي للمعاملة.
  • NET - تستند حصة الأرباح إلى نسبة مئوية من السعر الصافي للمعاملة.
 لا ينطبق لا
type

نوع خطة السعر وتشمل القيم الصالحة ما يلي:

  • REVSHARE - نموذج حصّة الأرباح
  • RATECARD - نموذج بطاقة السعر
  • REVSHARE_RATECARD - نموذج بطاقة السعر وحصة الأرباح
  • USAGE_TARGET - نموذج إشعارات قابل للتعديل

لمزيد من المعلومات حول أنواع خطط الأسعار، يمكنك الاطّلاع على أنواع خطط الأسعار المتوافقة.

 لا ينطبق نعم