أنت تطّلع على مستندات Apigee Edge.
انتقِل إلى مستندات
Apigee X. المعلومات
مقدمة
تمنحك ميزة تحقيق الربح المرونة اللازمة لإصدار رصيد المطوِّر.
بالنسبة إلى المطوّر الذي يستخدم رصيدًا مدفوعًا مسبقًا، يظهر الرصيد كانخفاض في الاستخدام، ما يؤدي إلى زيادة رصيد المطوّر المدفوع مسبقًا أو خفضه من الآن فصاعدًا. تمامًا مثل استخدام بطاقة السحب الآلي، يتم سحب الأموال من رصيد المطوّر المدفوع مسبقًا عندما يشتري المطوّر حِزمة منتجات واجهة برمجة التطبيقات. على المطوّر الاحتفاظ برصيد كافٍ لإجراء عمليات الشراء. اطّلِع على كيف يمكنني احتساب الرصيد المتبقّي في الحساب المدفوع مسبقًا؟
بالنسبة إلى المطوّر الذي يستخدم نظام الفوترة بعد الدفع، يظهر الرصيد على شكل سطر منفصل في الفاتورة، ما يؤدي إلى تخفيض الرسوم في الفاتورة.
استكشاف صفحة "الأرصدة"
يمكنك الوصول إلى صفحة الأرصدة واستكشافها، كما هو موضّح أدناه.
Edge
للوصول إلى صفحة "المساهمون" باستخدام واجهة مستخدم Edge:
- سجِّل الدخول إلى apigee.com/edge.
- انقر على النشر > تحقيق الربح > المساهمون في شريط التنقّل الأيمن.
تظهر صفحة "الأرصدة".
كما هو موضّح في الشكل، تتيح لك صفحة "الأرصدة" إجراء ما يلي:
- عرض معلومات موجزة عن جميع الأرصدة، بما في ذلك اسم المستلِم ومبلغ الرصيد وتاريخ ووقت سريان الرصيد، حِزمة منتجات واجهة برمجة التطبيقات ومنتجات واجهة برمجة التطبيقات التي ينطبق عليها الرصيد وأي ملاحظات تمت إضافتها
- إصدار رصيد
- البحث في قائمة المساهمين
Classic Edge (سحابة خاصة)
للوصول إلى صفحة "المساهمون" باستخدام واجهة مستخدم Edge الكلاسيكية:
- سجِّل الدخول إلى
http://ms-ip:9000
، حيث يكون ms-ip هو عنوان IP أو اسم نظام أسماء النطاقات الخاص بعقدة "خادم الإدارة". - اختَر تحقيق الربح > تقارير تحقيق الربح في شريط التنقّل العلوي.
تمكّنك صفحة الأرصدة من:
- عرض معلومات موجزة عن جميع الأرصدة، بما في ذلك اسم المستلِم ومبلغ الرصيد وتاريخ ووقت سريان الرصيد، حِزمة منتجات واجهة برمجة التطبيقات ومنتجات واجهة برمجة التطبيقات التي ينطبق عليها الرصيد وأي ملاحظات تمت إضافتها
- إصدار رصيد
- البحث في قائمة الأرصدة
إصدار ائتمان
- انتقل إلى صفحة "الأرصدة".
- انقر على + رصيد.
- أدخل المعلومات التالية:
الحقل الوصف شهر الفوترة شهر الفوترة الذي ينطبق فيه الرصيد اختَر شهرًا من القائمة.
مطور التطبيق اسم المطوّر أو الشركة التي ينطبق عليها الرصيد أدخِل الاسم في مربّع النص. أثناء الكتابة، يتم عرض قائمة بالمطوّرين/الشركات التي تحتوي على السلسلة في قائمة منسدلة. انقر على اسم المطوّر أو الشركة من القائمة المنسدلة.
ملاحظة: بعد اختيار مطوّر أو شركة، يتم عرض الحقول المتبقية. إذا اخترت شركة أو مطوّرًا لم يقبل خطة تعرفات، لا يمكنك إصدار رصيد.
حزمة المنتجات حزمة منتجات واجهة برمجة التطبيقات التي ينطبق عليها الرصيد اختَر من قائمة حِزم منتجات واجهة برمجة التطبيقات المتاحة.
المنتج منتج واجهة برمجة التطبيقات في حزمة منتج واجهة برمجة التطبيقات المحدّدة التي ينطبق عليها الرصيد اختَر كل المنتجات أو منتج واحد لواجهة برمجة التطبيقات من القائمة.
العملة العملة المستخدَمة للرصيد. يتم ضبط العملة لخطة الأسعار في حزمة منتجات واجهة برمجة التطبيقات التي اشتراها المطوِّر ولا يمكن تغييرها. إذا كانت هناك عملات متعدّدة محدّدة في خطة تعرفات، يمكنك الاختيار من بين إحدى العملات.
المبلغ مبلغ الرصيد (بالعملة المحدّدة) حدِّد قيمة موجبة أو سالبة. لا يمكن أن تكون القيمة صفرًا.
ملاحظة ملاحظة اختيارية لوصف سبب إضافة الرصيد
- انقر على حفظ الرصيد.
إصدار الأرصدة باستخدام واجهة برمجة التطبيقات
باستخدام واجهة برمجة التطبيقات، يمكنك منح المطوّر رصيدًا مقابل حِزمة منتجات واجهة برمجة التطبيقات ككل، أو مقابل استخدام منتج معيّن من منتجات واجهة برمجة التطبيقات في حِزمة منتجات واجهة برمجة التطبيقات.
لإصدار رصيد باستخدام واجهة برمجة التطبيقات، أرسِل طلب POST إلى /organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{rate-plan_id}/real-currency-credit-transactions
،
حيث يحدِّد {package_id}
و{rate-plan_id}
معرّف حِزمة منتجات واجهة برمجة التطبيقات وخطة الأسعار التي ينطبق عليها الرصيد، على التوالي.
عند إصدار الطلب، يجب تحديدها كمَعلمات طلب بحث:
- رقم تعريف المطوّر (عنوان البريد الإلكتروني) الذي ينطبق عليه الرصيد
- مبلغ الرصيد
- العملة المستخدَمة في الرصيد
- ملاحظة توضّح سبب إضافة الرصيد
يمكنك اختياريًا تحديد مَعلمات طلب البحث الإضافية التالية:
- شهر الفوترة الذي ينطبق عليه الرصيد يتم ضبط هذه القيمة تلقائيًا على الشهر الحالي.
- سنة الفوترة التي ينطبق عليها الرصيد يتم ضبط هذه القيمة تلقائيًا على السنة الحالية.
- منتج واجهة برمجة التطبيقات الذي ينطبق عليه الرصيد إذا لم تحدِّد معرّف منتج واجهة برمجة التطبيقات، ينطبق الرصيد على جميع منتجات واجهة برمجة التطبيقات في حِزمة منتجات واجهة برمجة التطبيقات.
على سبيل المثال، يمنح الطلب التالي رصيدًا بقيمة 100 دولار أمريكي لشهر الفوترة نيسان (أبريل) 2018
لمطوّر يُعرف باسم dev1@myorg.com
. ينطبق الرصيد على حزمة منتجات واجهة برمجة التطبيقات payment
وخطة الأسعار من payment_standard_plan
:
اطّلِع على مَعلمات طلب البحث في Credits API للحصول على قائمة كاملة بمَعلمات طلب البحث التي يمكنك تحديدها في طلب رصيد.
$ curl -H "Content-Type:application/json" -X POST \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/payment/rate-plans/payment_standard_plan/real-currency-credit-transactions?currencyId=usd&developerId=dev1@myorg.com&transactionAmount=100&transactionNote=Credit+for+failed+transactions&billingMonth=APRIL&billingYear=2013" \ -u email:password
في ما يلي مثال على مقتطف من الاستجابة:
{ "currency" : "USD", "developer" : { "address" : [ { "address1" : "Dev One Address", ... } ], "approxTaxRate" : 0.0000, "billingType" : "PREPAID", "broker" : false, "developerRole" : [ ], "email" : "dev1@myorg.com", "hasSelfBilling" : false, "id" : "K4jW2QLjZ1h8GFA8", "legalName" : "DEV ONE", "name" : "Dev One", "organization" : { ... }, "registrationId" : "TestRegId", "status" : "ACTIVE", "type" : "TRUSTED" }, "endTime" : "2013-09-04 15:54:36", "environment" : "PROD", "euroExchangeRate" : 0.8107, "gbpExchangeRate" : 0.6860, "id" : "904c3f73-ab8d-4e5d-a48c-225fd49a3bde", "isVirtualCurrency" : false, "notes" : "Credit for failed transactions", "pkgId" : "myorg@@@payment", "pkgRatePlanProductName" : "Payment", "providerTxId" : "904c3f73-ab8d-4e5d-a48c-225fd49a3bde", "rate" : 100, "ratePlan" : { ... }, "status" : "ACTIVE", "virtualCurrency" : false }, "description" : "Standard Plan", "displayName" : "Standard Plan", … "monetizationPackage" : { "description" : "Payment", ... } ], ... }, "product" : [ { "customAtt1Name" : "user", "description" : "Payment", "displayName" : "Payment", "id" : "payment", "name" : "payment", "organization" : { ... }, "status" : "CREATED", "transactionSuccessCriteria" : "Status=='200 OK'" } ], "status" : "CREATED" }, "name" : "Standard Plan", "organization" : { ... }, ... }, ... }, ... }, "revenueShareAmount" : 0, "startTime" : "2013-09-04 15:54:36", "status" : "SUCCESS", "taxModel" : "UNDISCLOSED", "txProviderStatus" : "SUCCESS", "type" : "CREDIT", "usdExchangeRate" : 1.0675, "utcEndTime" : "2013-09-04 15:54:36", "utcStartTime" : "2013-09-04 15:54:36" }
مَعلمات طلب البحث لواجهة برمجة التطبيقات Credits API
تتوفّر مَعلمات طلب البحث التالية للاستخدام مع واجهة برمجة تطبيقات الأرصدة:
الاسم | الوصف | تلقائي | مطلوب؟ |
---|---|---|---|
billingMonth |
شهر الفوترة الذي ينطبق فيه الرصيد، مثل أبريل. |
لا ينطبق | لا |
billingYear |
سنة الفوترة التي ينطبق عليها الرصيد، مثل 2018. |
لا ينطبق | لا |
currencyId |
العملة المستخدَمة في الرصيد يتم ضبط العملة لخطة الأسعار في حِزمة منتجات واجهة برمجة التطبيقات التي اشتراها المطوِّر ولا يمكن تغييرها. |
لا ينطبق | نعم |
developerId |
اسم المطوّر أو الشركة التي ينطبق عليها الرصيد |
لا ينطبق | نعم |
productId |
منتج واجهة برمجة التطبيقات الذي ينطبق عليه الرصيد في حال عدم تحديد معرّف منتج، يسري الرصيد على جميع منتجات واجهة برمجة التطبيقات في حزمة منتجات واجهة برمجة التطبيقات. |
لا ينطبق | لا |
transactionAmount |
مبلغ الرصيد (بالعملة المحدّدة) حدِّد قيمة موجبة أو سالبة. لا يمكن أن تكون القيمة صفرًا. |
لا ينطبق | نعم |
transactionNote |
يُرجى مراعاة أنّ يصف سبب الائتمان. |
لا ينطبق | نعم |