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

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

حذف عملة معتمَدة باستخدام واجهة برمجة التطبيقات

يمكنك حذف عملة معتمَدة عن طريق إرسال طلب DELETE إلى /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

تنطبق هذه السمة على المطوّرين الذين يدفعون لاحقًا فقط. حدّ الائتمان لل عملة المعتمَدة.

لا ينطبق لا
description

وصف للعملة المعتمَدة.

لا ينطبق نعم
displayName

الاسم الذي سيتم عرضه للعملة المعتمَدة.

لا ينطبق نعم
minimumTopupAmount

تنطبق هذه السمة على المطوّرين الذين يدفعون مسبقًا فقط. الحدّ الأدنى للمبلغ الذي يمكن للمطوّرين إضافته إلى رصيد حساب الدفع المسبق بالعملة المحدّدة.

لا ينطبق لا
name

رمز العملة بتنسيق ISO 4217، مثل USD للدولار الأمريكي.

لا ينطبق نعم
organization

المؤسسة التي تستخدم العملة المعتمَدة.

لا ينطبق نعم
status

حالة العملة المعتمَدة. تشمل القيم الصالحة ما يلي:

  • نشطة: العملة المعتمَدة متاحة للاستخدام.
  • غير نشطة: العملة المعتمَدة غير متاحة للاستخدام.
لا ينطبق نعم
virtualCurrency

يشير إلى ما إذا كانت العملة المعتمَدة عملة افتراضية. تشمل القيم الصالحة ما يلي:

  • صحيح: العملة المعتمَدة هي عملة افتراضية.
  • خطأ: العملة المعتمَدة ليست عملة افتراضية.
لا ينطبق نعم