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

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

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

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

بعد نشر خطة الأسعار، يمكن لمطوّر برامج أو شركة شرائها (أو قبولها) عن طريق إصدار طلب POST إلى /mint/organizations/{org_name}/developers/{developer_or_company_id}/developer-rateplans حيث يشير {org_name} إلى اسم المؤسسة و{developer_or_company_id} هو معرّف المطوّر أو الشركة.

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

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

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

تاريخ بدء خطة الأسعار على سبيل المثال: 2017-03-24.

لا ينطبق نعم
endDate

تاريخ انتهاء خطة الأسعار على سبيل المثال: 2017-09-24.

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

لا ينطبق لا
developer

السمة id التي تحدّد رقم تعريف المطوّر أو الشركة التي تشتري خطة الأسعار.

لا ينطبق نعم
quotaTarget

العدد المستهدف من المعاملات المسموح به لمطوِّر التطبيق. يمكنك ضبط ما إذا كان يتم إرسال الإشعارات ووقت إرسالها استنادًا إلى النسبة المئوية للرقم المستهدف الذي تم بلوغه، مثلاً 90% أو 100% أو 150%. ولن يتم حظر المعاملات الإضافية بعد الوصول إلى الرقم المستهدف.

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

0 لا
ratePlan

سمة واحدة (id) تحدِّد رقم تعريف خطة الأسعار.

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

لا ينطبق نعم
suppressWarning

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

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

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

  • true - التنازل عن رسوم الإنهاء عند إنهاء خطة السعر النشطة كجزء من تفعيل الخطة الجديدة.
  • false: يجب عدم التنازل عن رسوم الإنهاء عند إنهاء خطة السعر النشطة كجزء من عملية تفعيل خطة السعر الجديدة.
لا ينطبق لا

على سبيل المثال، يشتري الطلب التالي خطة السعر بقيمة location_&_messaging لمطوّر البرامج المحدَّد:

curl "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/5cTWgdUvdr6JW3xU/developer-rateplans" \
  -X POST \
  -H "Content-Type:application/json" \
  -u email:password \
  -d '{
   "developer":{
     "id":"5cTWgdUvdr6JW3xU"
   },
   "startDate":"2017-08-30",
   "ratePlan":{
     "id":"location_&_messaging"
   },
   "suppressWarning":false
  }'

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

يشتري الطلب التالي خطة معدل إشعارات قابلة للتعديل ويضبط العدد المستهدف من المعاملات على 4,000.

curl "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/5cTWgdUvdr6JW3xU/developer-rateplans" \
  -X POST \
  -H "Content-Type:application/json" \
  -u email:password \
  -d '{
   "developer":{
     "id":"5cTWgdUvdr6JW3xU"
   },
   "ratePlan":{
     "id":"adjustable-notification-plan"
   },
   "startDate": "2017-03-24",
   "quotaTarget": 4000,
   "suppressWarning":false
  }'

في أي من المثالين أعلاه، إذا تم عرض رسالة الخطأ التالية:

Developer legal name not specified. 

بعد ذلك، يجب ضبط سمتَي تحقيق الربح MINT_DEVELOPER_ADDRESS وMINT_DEVELOPER_LEGAL_NAME، ثم تكرار طلب البيانات من واجهة برمجة التطبيقات.

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

لإنهاء صلاحية (أو إلغاء) خطة أسعار اشتراها مطوّر برامج، عدِّل تفاصيل خطة الأسعار التي تم شراؤها وحدِّد السمة endDate في نص الطلب في طلب وضع البرامج (PUT) إلى المورد /organizations/{org_name}/developers/{developer_or_company_id}/developer-rateplans/{developer_rateplan_id}.

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

يتم عرض {developer_rateplan_id} في الردّ عند شراء خطة السعر المنشورة.

مثال:

{
  "created": "2017-03-31 18:59:54",
  "developer": {
    ...
  },
  "id": "b1c600b8-f871-496d-8173-12b9950d6ab1",
  "quotaTarget": 3000,
  "ratePlan": {
    ...
  },
  "startDate": "2017-03-31 00:00:00",
  "updated": "2017-03-31 18:59:54",
  "waiveTerminationCharge": false
}

بدلاً من ذلك، يمكنك الحصول على {developer-rateplan-id} لخطة أسعار المطوّرين من خلال إصدار طلب GET إلى /organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans، حيث يكون {developer_id} هو عنوان البريد الإلكتروني للمطوّر. لمزيد من المعلومات، يُرجى الاطّلاع على عرض جميع خطط الأسعار التي اشتراها المطوّر.

يعدِّل الطلب التالي تاريخ الانتهاء إلى 1 كانون الأول (ديسمبر) 2017. ويعني ذلك أنّ خطة الأسعار ستنتهي في نهاية يوم 30 تشرين الثاني (نوفمبر) 2017، وسيتم حظر جميع الطلبات المقدَّمة في 1 كانون الأول (ديسمبر) 2017.

curl "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans/b1c600b8-f871-496d-8173-12b9950d6ab1"
  -X PUT \
  -H "Content-Type:application/json" \
  -u email:password \
  -d '{
   "id" : "b1c600b8-f871-496d-8173-12b9950d6ab1",
   "developer":{
     "id":"dev@mycompany.com"
   },
   "ratePlan":{
     "id":"p1_adjustable-notification-plan"
   },
   "startDate": "2017-04-15 00:00:00",
   "endDate": "2017-11-30",
   "quotaTarget": 3000,
   "suppressWarning":false
  }'