أنت الآن بصدد الاطّلاع على مستندات Apigee Edge.
انتقِل إلى
مستندات Apigee X. info
مقدمة
في خطة الإشعارات القابلة للتعديل، يمكن لموفّر واجهة برمجة التطبيقات تعديل العدد المستهدف من المعاملات لكل مطوّر تطبيقات. يمكنك ضبط ما إذا كان سيتم إرسال الإشعارات ومتى سيتم إرسالها استنادًا إلى الوقت الذي يتم فيه بلوغ نسبة مئوية من العدد المستهدف، مثل %90 أو %100 أو %150. لا يتم حظر المعاملات الإضافية بعد الوصول إلى الرقم المستهدف.
إعداد خطة إشعارات قابلة للتعديل باستخدام واجهة المستخدم
اضبط خطط الإشعارات القابلة للتعديل، كما هو موضّح أدناه.
Edge
لضبط خطة إشعارات قابلة للتعديل باستخدام واجهة مستخدم Edge، عند إضافة أو تعديل خطة أسعار، اختَر نوع خطة الأسعار إشعار قابل للتعديل، وفي قسم إشعار قابل للتعديل، اضبط المعلومات التالية:
| الحقل | الوصف | تلقائي |
|---|---|---|
| معدّل تكرار الحساب | الفترة الزمنية التي يتم احتساب عدد المعاملات (أو عدد العناصر المرتبطة بالسمة المخصّصة) خلالها. اختَر عددًا من الأشهر (من شهر واحد إلى 24 شهرًا). | شهر واحد |
إذا حدّدت سمات مخصّصة لمنتج واجهة برمجة التطبيقات، يمكنك ضبط مَعلمة تقييم مخصّصة لتحديد عدّاد المعاملات استنادًا إلى سمة مخصّصة.
على سبيل المثال، قد تحتاج إلى:
- تحصيل مبلغ متغير من المطوّرين استنادًا إلى قيمة مقدَّمة في رسالة طلب بيانات من واجهة برمجة التطبيقات
على سبيل المثال، يمكنك تحصيل رسوم من مطوّري التطبيقات استنادًا إلى عدد وحدات البايت التي يتم نقلها في طلب بيانات من واجهة برمجة التطبيقات. - تجميع طلبات متعددة من واجهة برمجة التطبيقات في معاملة واحدة
في هذه الحالة، اختَر "استخدام مَعلمة التقييم المخصّصة" (Use custom rating parameter) واختَر السمة المخصّصة من القائمة المنسدلة.
لمزيد من المعلومات، يُرجى الاطّلاع على ضبط خطة الأسعار باستخدام سمات مخصّصة.
Classic Edge (Private Cloud)
لضبط خطط الإشعارات القابلة للتعديل باستخدام واجهة مستخدم Classic Edge، اتّبِع الخطوات التالية:
- اختَر إشعار قابل للتعديل في حقل نوع خطة الأسعار ضمن علامة التبويب "تفاصيل الخطة" في نافذة "خطة الأسعار".
راجِع إنشاء خطة أسعار باستخدام واجهة المستخدم للحصول على معلومات حول الوصول إلى نافذة "خطة الأسعار".
- اضبط حقل مدة التجديد على عدد الأشهر التي يتم فيها تجديد الخطة تلقائيًا (ما لم ينهِ المطوّر الاتفاقية قبل ذلك التاريخ). إذا ضبطت هذه القيمة على 0، ستظل الخطة سارية إلى أن يختار المطوّر إنهاءها.
- انقر على التفاصيل ضمن "خطة الأسعار العامة".
- اضبط أساس التجميع على الفترة الزمنية التي يتم تجميع عدد المعاملات خلالها. اختَر رقمًا بين شهر واحد و24 شهرًا. القيمة التلقائية هي شهر واحد.
- انقر على تطبيق وإغلاق.
- انقر على حفظ المسودة.
- لا تنشر الخطة إلا عندما تكون متأكدًا تمامًا من أنّها نهائية. راجِع مقالة خطط الأسعار المتعلقة بالنشر للحصول على معلومات حول ضبط "تاريخ النشر" ونشر الخطة.
بعد نشر خطة أسعار، يمكنك تعديل تاريخ الانتهاء فقط. لا يمكنك حذف خطة أسعار بعد نشرها، ولكن يمكنك إنهاء صلاحية خطة الأسعار واستبدالها بخطة أسعار مستقبلية، كما هو موضّح في مقالة إنهاء صلاحية خطة أسعار منشورة.
إعداد خطة إشعارات قابلة للتعديل باستخدام واجهة برمجة التطبيقات
حدِّد تفاصيل خطة الإشعارات القابلة للتعديل في السمة ratePlanDetails
في نص الطلب في طلب POST إلى
/organizations/{org_name}/monetization-packages/{package_id}/rate-plans.
لتحديد خطة إشعارات قابلة للتعديل، حدِّد القيم التالية في ratePlanDetails ضمن نص الطلب:
| الموقع | القيمة |
|---|---|
type |
اضبط النوع على USAGE_TARGET. |
meteringType |
اضبط النوع على DEV_SPECIFIC. |
duration |
يتم ضبطها على الفترة الزمنية لأساس التجميع، بالإضافة إلى
durationType. بالنسبة إلى خطط معدّل الإشعارات القابلة للتعديل، اضبط هذا الخيار على قيمة عدد صحيح
تتراوح بين 1 و24. |
durationType |
يتم ضبطها على الفترة الزمنية التي يتم فيها تجميع البيانات، بالإضافة إلى
|
لمزيد من المعلومات حول خصائص الإعداد التي يمكن ضبطها عند تحديد تفاصيل خطة الإشعارات القابلة للتعديل، يُرجى الاطّلاع على إعدادات ضبط تفاصيل خطة الأسعار.
على سبيل المثال، يحدّد ما يلي خطة إشعارات قابلة للتعديل مع أساس تجميع تم ضبطه على شهر واحد.
$ curl -H "Content-Type:application/json" -X POST -d \
'{
"name": "AdjustableNotification",
"displayName": "Adjustable notification plan",
"description": "Adjustable notification plan",
"published": "true",
"organization": {
"id": "myorg"
},
"startDate": "2016-04-15 00:00:00",
"type": "STANDARD",
"monetizationPackage": {
"id": "p1",
"name": "test"
},
"currency": {
"id" : "usd",
"name" : "USD"
},
"ratePlanDetails": [
{
"type": "USAGE_TARGET",
"meteringType": "DEV_SPECIFIC",
"duration": 1,
"durationType": "MONTH",
"ratingParameter": "VOLUME",
"organization": {
"id": "myorg"
},
"currency": {
"id": "usd",
"name": "USD"
}
}
]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/p1/rate-plans" \
-u email:password
تحديد عدد المعاملات المستهدَف لكل مطوّر تطبيقات يستخدم واجهة برمجة التطبيقات
يمكنك تحديد العدد المستهدَف من المعاملات لمطوّر تطبيق عندما يقبل المطوّر خطة الأسعار، ويمكنك تعديل القيمة لاحقًا.
تحديد عدد المعاملات المستهدَف عند قبول خطة الأسعار
عند قبول خطة الأسعار، لتحديد عدد المعاملات المستهدَف، حدِّد السمة quotaTarget في نص الطلب في طلب POST إلى المرجع /organizations/{org_name}/developers/{developer_id}/developer-rateplans.
اضبط قيمة quotaTarget على عدد صحيح موجب أو 0 لإيقاف الإشعارات التي يرسلها مطوّر التطبيق. إذا لم يتم تحديدها، تكون القيمة التلقائية quotaTarget هي 0.
على سبيل المثال، يضبط الطلب التالي العدد المستهدَف للمعاملات على 4000 عندما يوافق مطوّر التطبيق على خطة الإشعارات القابلة للتعديل.
$ curl -H "Content-Type:application/json" -X POST -d \
'{
"developer":{
"id":"dev@mycompany.org"
},
"ratePlan":{
"id":"p1_adjustable-notification-plan"
},
"startDate": "2016-03-24 00:00:00",
"quotaTarget": 4000,
"suppressWarning": false
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans" \
-u email:password
ضبط العدد المستهدَف من المعاملات عند تعديل خطة الأسعار المقبولة
لضبط عدد المعاملات المستهدَف، يمكنك تعديل خطة الأسعار المقبولة وتحديد السمة quotaTarget في نص الطلب في طلب PUT إلى المورد /organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id}. اضبط قيمة quotaTarget على عدد صحيح موجب أو 0 لإيقاف الإشعارات لمطوّر التطبيق. إذا لم يتم تحديدها، تكون القيمة التلقائية quotaTarget هي 0.
يتم عرض {developer_rateplan_id} في الردّ عند قبول خطة الأسعار المنشورة.
على سبيل المثال:
{
"created": "2016-03-31 18:59:54",
"developer": {
...
},
"id": "b1c600b8-f871-496d-8173-12b9950d6ab1",
"quotaTarget": 3000,
"ratePlan": {
...
},
"startDate": "2016-03-31 00:00:00",
"updated": "2016-03-31 18:59:54",
"waiveTerminationCharge": false
}
بدلاً من ذلك، يمكنك الحصول على {developer-rateplan-id} لخطة الأسعار الخاصة بالمطوّرين
من خلال إرسال طلب GET إلى
/organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans،
حيث {developer_id} هو عنوان البريد الإلكتروني للمطوّر. لمزيد من المعلومات، اطّلِع على مقالة عرض جميع خطط الأسعار التي يقبلها أحد المطوّرين.
على سبيل المثال:
{
"developerRatePlan": [
{
"created": "2016-03-31 14:52:30",
"developer": {
...
},
"id": "b1c600b8-f871-496d-8173-12b9950d6ab1",
"quotaTarget": 3000,
"ratePlan": {
...
},
"startDate": "2016-03-31 00:00:00",
"updated": "2016-03-31 18:59:54"
}
],
"totalRecords": 1
}
يعدّل الطلب التالي العدد المستهدَف من المعاملات إلى 4000.
$ curl -H "Content-Type:application/json" -X PUT -d \
'{
"id" : "b1c600b8-f871-496d-8173-12b9950d6ab1",
"developer":{
"id":"dev@mycompany.com"
},
"ratePlan":{
"id":"p1_adjustable-notification-plan"
},
"startDate": "2016-04-15 00:00:00",
"quotaTarget": 4000,
"suppressWarning":false
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans/b1c600b8-f871-496d-8173-12b9950d6ab1"
-u email:password