أنت تطّلع على مستندات Apigee Edge.
انتقِل إلى
مستندات Apigee X. info
مقدمة
يعمل فريق إعداد Apigee Edge على ضبط العملات والعملة التلقائية التي تتيحها مؤسستك كجزء من عملية الإعداد الأوّلية لتحقيق الربح.
يمكنك عرض العملات التي تتيحها مؤسستك أو إضافة العملات المسموح بها أو حذف العملات المتاحة (إذا لم يستخدم مطوّر البرامج أو خطة أسعار العملات).
إدارة العملات المعتمَدة باستخدام واجهة المستخدم
يمكنك إدارة العملات المسموح بها وضبط العملة التلقائية في قسم "الضريبة والعملة" في صفحة "الملف الشخصي للمؤسسة". اطّلِع على إدارة الملف الشخصي للمؤسسة باستخدام واجهة المستخدم للاطّلاع على التفاصيل.
إدارة العملات المعتمَدة باستخدام واجهة برمجة التطبيقات
يمكنك إدارة العملات المتاحة باستخدام واجهة برمجة التطبيقات، كما هو موضَّح في الأقسام التالية.
عرض العملات المتاحة باستخدام واجهة برمجة التطبيقات
يمكنك عرض عملة فردية معتمَدة في مؤسستك أو جميع العملات التي تتيحها مؤسستك.
للاطّلاع على عملة فردية تتيحها مؤسستك، أرسِل طلب GET إلى /mint/organizations/{org_name}/supported-currencies/{supportedCurrencyId}، حيث يمثّل {supportedCurrency_id} معرّف العملة المتوافقة المطلوب الاطّلاع عليها. على سبيل المثال:
curl -X GET -H "Accept: application/json" \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/supported-currencies/usd" \
-u email:password
للاطّلاع على جميع العملات التي تتيحها مؤسستك، يمكنك إصدار طلب GET إلى
/mint/organizations/{org_name}/supported-currencies. على سبيل المثال:
curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/supported-currencies" \
-H "Accept: application/json" \
-u email:password
في ما يلي مثال على الردّ:
{
"supportedCurrency" : [ {
"description" : "US Dollar",
"displayName" : "US Dollar",
"id" : "usd",
"name" : "USD",
"organization" : {
...
"status" : "ACTIVE",
"virtualCurrency" : false
}, {
"creditLimit" : 5000.0000,
"description" : "Euro",
"displayName" : "Euro",
"id" : "eur",
"name" : "EUR",
"organization" : {
...
},
"status" : "INACTIVE",
"virtualCurrency" : false
} ],
"totalRecords" : 2
}
إضافة العملات المعتمَدة باستخدام واجهة برمجة التطبيقات
أضِف العملات المتوافقة من خلال إرسال طلب POST إلى
/mint//organizations/{org_name}/supported-currencies. لكل عملة متوافقة تضيفها،
عليك تحديد المعلومات التالية في نص الطلب:
- اسم العملة المعتمَدة. الاسم هو رمز ISO 4217 للعملة، مثل USD لدولارสหรัฐ.
- الاسم المعروض
- الوصف.
- ما إذا كانت العملة افتراضية أم لا.
- حالة العملة، أي ما إذا كانت العملة متاحة للاستخدام أم لا.
- المؤسسة التي ستتم إضافة العملة المتوافقة إليها
يمكنك اختياريًا ضبط ما يلي:
- حدّ الائتمان لعملة متوافقة (المطوّرون الذين يستخدمون نظام الفوترة بعد الدفع فقط)
- الحد الأدنى لإضافة رصيد بعملة متوافقة (للمطوّرين الذين يستخدمون الرصيد المدفوع مسبقًا فقط)
اطّلِع على خصائص ضبط العملة المسموح بها للحصول على مزيد من المعلومات.
على سبيل المثال، يضيف ما يلي عملة متوافقة لمؤسسة:
curl -H "Content-Type: application/json" -X POST -d \
'{
"description": "US Dollar",
"displayName": "US Dollar",
"virtualCurrency": "false",
"name": "USD",
"organization": {
"id": "{org_name}"
},
"status": "ACTIVE"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/supported-currencies" \
-u email:password
ضبط العملة التلقائية باستخدام واجهة برمجة التطبيقات
اضبط العملة التلقائية للمؤسسة من خلال ضبط قيمة currency على رمز ISO 4217 معتمد
للعملة عند تعديل الملف الشخصي للمؤسسة، كما هو موضّح في مقالة إدارة الملف الشخصي
للمؤسسة باستخدام واجهة برمجة التطبيقات.
تعديل عملة متوافقة باستخدام واجهة برمجة التطبيقات
عدِّل عملة متوافقة من خلال إرسال طلب PUT إلى
/mint/organizations/{org_name}/{supportedCurrencyId}، حيث يمثّل
{supportedCurrency_id} معرّف العملة المتوافقة التي تريد تعديلها. عليك تحديد السمات المعدّلة
ومعرّف العملة المتوافق في نص الطلب. على سبيل المثال، يؤدي طلب البيانات من واجهة برمجة التطبيقات التالي إلى تعديل الوصف والاسم المعروض لعملة متوافقة (يتم تمييز السمات المعدّلة في المثال):
curl -H "Content-Type: application/json" -X PUT -d \
'{
"description": "United States Dollar",
"displayName": "United States Dollar",
"id": "usd",
"name": "USD",
"organization": {
"id": "{org_name}"
},
"status" : "ACTIVE",
"virtualCurrency": "false"
}' \
"https://api.enterprise.apigee.com/v1/mint/organization/{org_name}/supported-currencies/usd" -d \
-u email:password
حذف عملة متوافقة باستخدام واجهة برمجة التطبيقات
يمكنك حذف عملة متوافقة من خلال إصدار طلب حذف إلى /mint/organizations/{org_name}/supported-currencies/{currency_id}، حيث يشير {currency_id} إلى العملة المتوافقة المطلوب حذفها. على سبيل
المثال:
curl -X DELETE -H "Accept: application/json" \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/supported-currencies/usd" \
-u email:password
سمات إعداد العملة لواجهة برمجة التطبيقات
يلخّص الجدول التالي سمات الضبط التي يمكن ضبطها باستخدام واجهة برمجة التطبيقات.
| الاسم | الوصف | تلقائي | مطلوب؟ |
|---|---|---|---|
| creditLimit |
تنطبق هذه السمة على المطوّرين الذين يستخدمون نظام الدفع الآجل فقط. حدّ الائتمان للعملة المتوافقة. |
لا ينطبق | لا |
| الوصف |
وصف للعملة المتوافقة |
لا ينطبق | نعم |
| displayName |
الاسم الذي سيتم عرضه للعملة المتوافقة. |
لا ينطبق | نعم |
| minimumTopupAmount |
تنطبق هذه السمة على المطوّرين الذين يستخدمون نظام الدفع المسبق فقط. الحد الأدنى للمبلغ الذي يمكن للمطوّرين إضافته إلى رصيد حساب الدفع المُسبَق بالعملة المحدّدة. |
لا ينطبق | لا |
| الاسم |
رمز ISO 4217 للعملة، مثل USD للدولار الأمريكي |
لا ينطبق | نعم |
| مؤسسة |
المؤسسة التي تتعامل بالعملة المتوافقة. |
لا ينطبق | نعم |
| status |
حالة العملة المتوافقة. تشمل القيم الصالحة ما يلي:
|
لا ينطبق | نعم |
| virtualCurrency |
يشير إلى ما إذا كانت العملة المتوافقة هي عملة افتراضية. تشمل القيم الصالحة ما يلي:
|
لا ينطبق | نعم |