ارزهای پشتیبانی شده را مدیریت کنید

شما در حال مشاهده مستندات Apigee Edge هستید.
به مستندات Apigee X مراجعه کنید .
اطلاعات

مقدمه

به عنوان بخشی از تنظیمات اولیه کسب درآمد، تیم پیکربندی Apigee Edge، ارزها و ارز پیش‌فرض پشتیبانی شده توسط سازمان شما را پیکربندی می‌کند.

شما می‌توانید ارزهایی را که سازمان شما پشتیبانی می‌کند مشاهده کنید، ارزهای پشتیبانی شده را اضافه کنید یا ارزهای پشتیبانی شده را حذف کنید (اگر ارزها توسط یک توسعه‌دهنده یا یک طرح نرخ استفاده نمی‌شوند).

مدیریت ارزهای پشتیبانی شده با استفاده از رابط کاربری

ارزهای پشتیبانی‌شده را مدیریت کنید و ارز پیش‌فرض را در بخش مالیات و ارز در صفحه نمایه سازمان تنظیم کنید. برای جزئیات بیشتر به مدیریت نمایه سازمان با استفاده از رابط کاربری مراجعه کنید.

مدیریت ارزهای پشتیبانی شده با استفاده از API

ارزهای پشتیبانی شده را با استفاده از API، همانطور که در بخش‌های بعدی توضیح داده شده است، مدیریت کنید.

مشاهده ارزهای پشتیبانی شده با استفاده از API

یک ارز خاص پشتیبانی شده توسط سازمان خود یا تمام ارزهای پشتیبانی شده توسط سازمان خود را مشاهده کنید.

برای مشاهده یک واحد پول خاص که توسط سازمان شما پشتیبانی می‌شود، یک درخواست 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
}

تنظیم ارز پیش‌فرض با استفاده از API

با تنظیم مقدار currency به یک کد ارز پشتیبانی شده ISO 4217 هنگام ویرایش پروفایل سازمان، همانطور که در مدیریت پروفایل سازمان با استفاده از API توضیح داده شده است، ارز پیش‌فرض سازمان را تنظیم کنید.

ویرایش یک ارز پشتیبانی شده با استفاده از API

با ارسال یک درخواست PUT به /mint/organizations/{org_name}/{supportedCurrencyId} ، یک ارز پشتیبانی‌شده را ویرایش کنید، که در آن {supportedCurrency_id} شناسه ارز پشتیبانی‌شده برای به‌روزرسانی است. شما باید در بدنه درخواست، ویژگی‌های به‌روزرسانی‌شده و همچنین شناسه ارز پشتیبانی‌شده را مشخص کنید. برای مثال، فراخوانی API زیر توضیحات و نام نمایشی را برای یک ارز پشتیبانی‌شده ویرایش می‌کند (ویژگی‌های به‌روزرسانی‌شده در مثال هایلایت شده‌اند):

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

حذف یک ارز پشتیبانی شده با استفاده از API

با ارسال درخواست 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

ویژگی‌های پیکربندی ارز برای API

جدول زیر خلاصه‌ای از ویژگی‌های پیکربندی را که می‌توان با استفاده از API تنظیم کرد، نشان می‌دهد.

نام توضیحات پیش‌فرض الزامی است؟
محدودیت اعتبار

این ویژگی فقط برای توسعه‌دهندگان پس‌پرداخت اعمال می‌شود. محدودیت اعتبار برای ارز پشتیبانی‌شده.

ناموجود خیر
توضیحات

توضیحی در مورد ارز پشتیبانی شده.

ناموجود بله
نام نمایش

نامی که برای ارز پشتیبانی شده نمایش داده می‌شود.

ناموجود بله
حداقل مبلغ شارژ

این ویژگی فقط برای توسعه‌دهندگان پیش‌پرداخت اعمال می‌شود. حداقل مبلغی که توسعه‌دهندگان می‌توانند به موجودی حساب پیش‌پرداخت خود به ارز مشخص‌شده اضافه کنند.

ناموجود خیر
نام

کد ISO 4217 برای واحد پول، مانند USD برای دلار ایالات متحده.

ناموجود بله
سازمان

سازمان مربوط به ارز پشتیبانی شده.

ناموجود بله
وضعیت

وضعیت ارز پشتیبانی شده. مقادیر معتبر عبارتند از:

  • فعال: ارز پشتیبانی شده برای استفاده در دسترس است.
  • غیرفعال: ارز پشتیبانی‌شده برای استفاده در دسترس نیست.
ناموجود بله
ارز مجازی

نشان می‌دهد که آیا ارز پشتیبانی‌شده، ارز مجازی است یا خیر. مقادیر معتبر عبارتند از:

  • درست: ارز پشتیبانی شده، ارز مجازی است.
  • false: ارز پشتیبانی‌شده، ارز مجازی نیست.
ناموجود بله