مدیریت واحدهای پول پشتیبانی‌شده

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

مقدمه

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

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

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

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

مدیریت ارزهای پشتیبانی‌شده بااستفاده از 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

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

تنظیم ارز پیش‌فرض بااستفاده از 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

دارایی‌های پیکربندی واحد پول برای میانای برنامه‌سازی کاربردی

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