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

شما در حال مشاهده اسناد 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

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

ویرایش یک ارز پشتیبانی شده با استفاده از 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 تنظیم کرد، خلاصه می کند.

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

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

N/A خیر
توضیحات

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

N/A بله
نمایش نام

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

N/A بله
minimalTopupAmount

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

N/A خیر
نام

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

N/A بله
سازمان

سازمان برای ارز مورد حمایت.

N/A بله
وضعیت

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

  • ACTIVE: ارز پشتیبانی شده برای استفاده در دسترس است.
  • غیر فعال: ارز پشتیبانی شده برای استفاده در دسترس نیست.
N/A بله
ارز مجازی

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

  • true: ارز پشتیبانی شده، ارز مجازی است.
  • false: ارز پشتیبانی شده، ارز مجازی نیست.
N/A بله