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

أنت تطّلع على مستندات 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
  }'