إدارة العملات المعتمدة

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

مقدمة

في إطار عملية الإعداد الأولية لتحقيق الربح، يضبط فريق إعداد 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 للدولار الأمريكي.	لا ينطبق	نعم
مؤسسة	تمثّل هذه السمة المؤسسة للعملة المتوافقة.	لا ينطبق	نعم
الحالة	حالة العملة المتوافقة. وتشمل القيم الصالحة ما يلي: نشطة: العملة المعتمدة متاحة للاستخدام. غير نشطة: العملة المعتمدة غير متاحة للاستخدام.	لا ينطبق	نعم
virtualCurrency	يشير إلى ما إذا كانت العملة المعتمدة هي العملة الافتراضية. وتشمل القيم الصالحة ما يلي: true: العملة المعتمدة هي العملة الافتراضية. خطأ: العملة المعتمدة ليست عملة افتراضية.	لا ينطبق	نعم